ジャンプ先

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

デフォルトの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

タイトル: EnvironmentDbcaJobs

ソースの表示

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

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

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

タイプ: array

ソースの表示

• 配列: オブジェクト EnvironmentDbcaJobsItem
  タイトル: EnvironmentDbcaJobsItem

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

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

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

タイプ: array

ソースの表示

• 配列: オブジェクト LinkRelation
  タイトル: LinkRelation

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

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

タイプ: object

タイトル: EnvironmentDbcaJobsItem

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

ソースの表示

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

{
    "title":"EnvironmentDbcaJobsItem",
    "description":"Describes a Database Configuration Assistant job.",
    "type":"object",
    "properties":{
        "job_id":{
            "description":"Unique identifier for the DBCA job in the Oracle Home.",
            "type":"string"
        },
        "description":{
            "description":"DBCA job description.",
            "type":"string"
        },
        "status":{
            "description":"DBCA job status.",
            "type":"string"
        },
        "submitted":{
            "description":"Timestamp for when the DBCA job request was submitted.",
            "type":"string"
        },
        "finished":{
            "description":"Timestamp for when the DBCA job request finished.",
            "type":"string"
        },
        "job_request":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/definitions/JobRequest"
                },
                {
                    "description":"Describes the DBCA job request."
                }
            ]
        },
        "dbca_log":{
            "description":"The output from the DBCA process as it executes.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkRelation"
            }
        }
    }
}

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

タイプ: array

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

ソースの表示

• 配列: 文字列

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

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

タイプ: object

すべてに一致

ソースの表示

• object JobRequest
  タイトル: JobRequest

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

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/JobRequest"
        },
        {
            "description":"Describes the DBCA job request."
        }
    ]
}

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

タイプ: array

ソースの表示

• 配列: オブジェクト LinkRelation
  タイトル: LinkRelation

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

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

タイプ: object

タイトル: JobRequest

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

ソースの表示

• container_configuration(optional): object container_configuration
• database_system_identifier(optional): string
  データベース識別子。
• global_database_name(optional): string
  グローバル・データベース名。
• operation(optional): string
  実行するDBCA操作。CREATEまたはDELETE。
• response_file(optional): string
  データベース作成時に使用する、DBCAのレスポンス・ファイルのパス
• template_name(optional): string
  データベース作成時に使用する、DBCAのデータベース・テンプレートのパス
• total_memory(optional): string
  データベース作成時にDBCAに指定する合計メモリー・パラメータ
• username(optional): string
  データベース削除時に使用する、DBCAのsysdbaユーザー名

{
    "title":"JobRequest",
    "description":"Describes the DBCA job request.",
    "type":"object",
    "properties":{
        "operation":{
            "description":"The DBCA operation to be performed: CREATE or DELETE.",
            "type":"string"
        },
        "container_configuration":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/definitions/ContainerConfiguration"
                },
                {
                    "description":"This object represents container configuration details for a CDB."
                }
            ]
        },
        "database_system_identifier":{
            "description":"The database identifier.",
            "type":"string"
        },
        "global_database_name":{
            "description":"Global database name.",
            "type":"string"
        },
        "response_file":{
            "description":"Path for response file for DBCA to use when creating a database.",
            "type":"string"
        },
        "template_name":{
            "description":"Path for the database template for DBCA to use when creating a database.",
            "type":"string"
        },
        "total_memory":{
            "description":"Total memory parameter to provide to DBCA when creating a database.",
            "type":"string"
        },
        "username":{
            "description":"The sysdba username for DBCA to use when deleting a database.",
            "type":"string"
        }
    }
}

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

タイプ: object

すべてに一致

ソースの表示

• object ContainerConfiguration
  タイトル: ContainerConfiguration

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

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/ContainerConfiguration"
        },
        {
            "description":"This object represents container configuration details for a CDB."
        }
    ]
}

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

タイプ: object

タイトル: ContainerConfiguration

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

ソースの表示

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

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

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

タイプ: object

タイトル: LinkRelation

ソースの表示

• href: string
• rel: string

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

先頭に戻る