ジャンプ先

• リクエスト
• レスポンス

デフォルトのOracleホームでORDSデータベースAPIを介して作成されたDBCAジョブのリストの取得

get

/environment/dbca/jobs/

デフォルトのOracleホームでORDSデータベースAPIを介して作成されたすべてのDBCAジョブの説明を返します。このOracleホームは、$ORACLE_HOME環境変数によって指定され、Oracle REST Data Servicesサーバー・インスタンスと同じホスト上に存在する必要があります。クライアントは、このサービスを起動するにはシステム管理者ロールが必要です。

リクエスト

この操作にはリクエスト・パラメータはありません。

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json

200 レスポンス

デフォルトのOracleホームに作成されたすべてのDBCAジョブの説明。

本文 ()

ルート・スキーマ: EnvironmentDbcaJobs

タイプ: object

ソースの表示

• count: integer
  現在のレスポンス内のレコードの合計数
• hasMore: boolean
  取得するレコードがさらにあるかどうか
• items: array items
• limit: integer
  サーバーによって適用されるレコード数に関する実際のページ・サイズ制限
• links: array links
• offset: integer
  項目リソースの返戻元となる実際の索引

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EnvironmentDbcaJobsItem"
            }
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates if there are more records to be retrieved."
        },
        "limit":{
            "type":"integer",
            "description":"The actual page size limit on number of records applied by the server."
        },
        "offset":{
            "type":"integer",
            "description":"The actual index from which the item resources are returned."
        },
        "count":{
            "type":"integer",
            "description":"Total number of records in the current response."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LinkRelation"
            }
        }
    }
}

ネストされたスキーマ: items

タイプ: array

ソースの表示

• 配列: オブジェクト EnvironmentDbcaJobsItem
  Database Configuration Assistantジョブについて説明します。

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/EnvironmentDbcaJobsItem"
    }
}

ネストされたスキーマ: links

タイプ: array

ソースの表示

• 配列: オブジェクト LinkRelation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/LinkRelation"
    }
}

ネストされたスキーマ: EnvironmentDbcaJobsItem

タイプ: object

Database Configuration Assistantジョブについて説明します。

ソースの表示

• dbca_log: array dbca_log
  DBCAプロセスの実行時の出力
• description: string
  DBCAジョブの説明
• finished: string
  DBCAジョブ・リクエストが完了した時点のタイムスタンプ
• job_id: string
  OracleホームでのDBCAジョブの一意の識別子
• job_request: object job_request
  DBCAジョブ・リクエストについて説明する
• links: array links
• status: string
  DBCAジョブのステータス
• submitted: string
  DBCAジョブ・リクエストが発行された時点のタイムスタンプ

{
    "type":"object",
    "description":"Describes a Database Configuration Assistant job.",
    "properties":{
        "job_id":{
            "type":"string",
            "description":"Unique identifier for the DBCA job in the Oracle Home."
        },
        "description":{
            "type":"string",
            "description":"DBCA job description."
        },
        "status":{
            "type":"string",
            "description":"DBCA job status."
        },
        "submitted":{
            "type":"string",
            "description":"Timestamp for when the DBCA job request was submitted."
        },
        "finished":{
            "type":"string",
            "description":"Timestamp for when the DBCA job request finished."
        },
        "job_request":{
            "type":"object",
            "description":"Describes the DBCA job request.",
            "properties":{
                "operation":{
                    "type":"string",
                    "description":"The DBCA operation to be performed: CREATE or DELETE."
                },
                "container_configuration":{
                    "type":"object",
                    "description":"This object represents container configuration details for a CDB.",
                    "properties":{
                        "number_of_pdbs":{
                            "type":"string",
                            "description":"Number of PDBs to create."
                        },
                        "pdb_name":{
                            "type":"string",
                            "description":"Base name of each PDB. A number is appended to each name if number_of_pdbs is greater than 1."
                        }
                    }
                },
                "database_system_identifier":{
                    "type":"string",
                    "description":"The database identifier."
                },
                "global_database_name":{
                    "type":"string",
                    "description":"Global database name."
                },
                "response_file":{
                    "type":"string",
                    "description":"Path for response file for DBCA to use when creating a database."
                },
                "template_name":{
                    "type":"string",
                    "description":"Path for the database template for DBCA to use when creating a database."
                },
                "total_memory":{
                    "type":"string",
                    "description":"Total memory parameter to provide to DBCA when creating a database."
                },
                "username":{
                    "type":"string",
                    "description":"The sysdba username for DBCA to use when deleting a database."
                }
            }
        },
        "dbca_log":{
            "type":"array",
            "description":"The output from the DBCA process as it executes.",
            "items":{
                "type":"string"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LinkRelation"
            }
        }
    }
}

ネストされたスキーマ : dbca_log

タイプ: array

DBCAプロセスの実行時の出力

ソースの表示

• 配列: 文字列

{
    "type":"array",
    "description":"The output from the DBCA process as it executes.",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: job_request

タイプ: object

DBCAジョブ・リクエストについて説明する

ソースの表示

• container_configuration: object container_configuration
  このオブジェクトは、CDBのコンテナ構成詳細を表します。
• database_system_identifier: string
  データベース識別子
• global_database_name: string
  グローバル・データベース名
• operation: string
  実行するDBCA操作。CREATEまたはDELETE。
• response_file: string
  データベース作成時に使用する、DBCAのレスポンス・ファイルのパス
• template_name: string
  データベース作成時に使用する、DBCAのデータベース・テンプレートのパス
• total_memory: string
  データベース作成時にDBCAに指定する合計メモリー・パラメータ
• username: string
  データベース削除時に使用する、DBCAのsysdbaユーザー名

{
    "type":"object",
    "description":"Describes the DBCA job request.",
    "properties":{
        "operation":{
            "type":"string",
            "description":"The DBCA operation to be performed: CREATE or DELETE."
        },
        "container_configuration":{
            "type":"object",
            "description":"This object represents container configuration details for a CDB.",
            "properties":{
                "number_of_pdbs":{
                    "type":"string",
                    "description":"Number of PDBs to create."
                },
                "pdb_name":{
                    "type":"string",
                    "description":"Base name of each PDB. A number is appended to each name if number_of_pdbs is greater than 1."
                }
            }
        },
        "database_system_identifier":{
            "type":"string",
            "description":"The database identifier."
        },
        "global_database_name":{
            "type":"string",
            "description":"Global database name."
        },
        "response_file":{
            "type":"string",
            "description":"Path for response file for DBCA to use when creating a database."
        },
        "template_name":{
            "type":"string",
            "description":"Path for the database template for DBCA to use when creating a database."
        },
        "total_memory":{
            "type":"string",
            "description":"Total memory parameter to provide to DBCA when creating a database."
        },
        "username":{
            "type":"string",
            "description":"The sysdba username for DBCA to use when deleting a database."
        }
    }
}

ネストされたスキーマ: links

タイプ: array

ソースの表示

• 配列: オブジェクト LinkRelation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/LinkRelation"
    }
}

ネストされたスキーマ : container_configuration

タイプ: object

このオブジェクトは、CDBのコンテナ構成詳細を表します。

ソースの表示

• number_of_pdbs: string
  作成するPDBの数
• pdb_name: string
  各PDBのベース名。number_of_pdbsが1よりも大きい場合は、それぞれの名前に番号が追加される。

{
    "type":"object",
    "description":"This object represents container configuration details for a CDB.",
    "properties":{
        "number_of_pdbs":{
            "type":"string",
            "description":"Number of PDBs to create."
        },
        "pdb_name":{
            "type":"string",
            "description":"Base name of each PDB. A number is appended to each name if number_of_pdbs is greater than 1."
        }
    }
}

ネストされたスキーマ: LinkRelation

タイプ: object

ソースの表示

• href(required): string
• rel(required): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href"
    ]
}

先頭に戻る