ジャンプ先

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

Oracleホームでの新しいDBCAジョブの作成

POST

/environment/homes/{homeName}/dbca/jobs/

指定されたOracleホームでデータベースをCREATEまたはDELETEするための新しいDBCAジョブ・リクエストを発行します。このOracleホームは、Oracle REST Data Servicesサーバー・インスタンスと同じホスト上にある必要があります。クライアントは、このサービスを起動するにはシステム管理者ロールが必要です。この実装は、Unixベースのオペレーティング・システムでのみ使用できます。

リクエスト

パス・パラメータ

• homeName(required): string
  Oracleホームの名前。

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

• application/json

リクエスト本文 - application/json ()

ルート・スキーマ: schema

タイプ: object

ソースの表示

• container_configuration: object container_configuration
  このオブジェクトは、指定されたPDB設定を使用してコンテナ・データベースを作成することを指定します。
• global_database_name(required): string
  作成または削除するデータベースを識別するためのグローバル・データベース名
• operation(required): string
  指定できる値: [ "CREATE", "DELETE" ]

  実行するDBCA操作。
• password: string
  データベースの削除にDBCAが使用するSYSDBAロールを持つアカウントのパスワードを指定します。DELETE操作にのみ必要です。
• response_file: string
  データベースの作成時に使用するDBCAのレスポンス・ファイルの名前。
• sys_user_password: string
  新しいデータベースのsysユーザーのパスワード。
• system_user_password: string
  新しいデータベースのシステム・ユーザーのパスワード。
• template_name: string
  データベースの作成時に使用するDBCAのテンプレート・ファイルの名前。
• total_memory: integer
  新しいデータベースが使用できる物理メモリーの合計量(MB)。
• username: string
  データベースの削除にDBCAが使用するSYSDBAロールを持つアカウントを指定します。DELETE操作にのみ必要です。

{
    "type":"object",
    "required":[
        "operation",
        "global_database_name"
    ],
    "properties":{
        "operation":{
            "type":"string",
            "description":"The DBCA operation to perform.",
            "enum":[
                "CREATE",
                "DELETE"
            ]
        },
        "global_database_name":{
            "type":"string",
            "description":"Global Database Name to identify the database to create or delete"
        },
        "template_name":{
            "type":"string",
            "description":"The name of the template file for DBCA to use when creating a database."
        },
        "response_file":{
            "type":"string",
            "description":"The name of the response file for DBCA to use when creating a database."
        },
        "system_user_password":{
            "type":"string",
            "description":"The password for the system user in the new database."
        },
        "sys_user_password":{
            "type":"string",
            "description":"The password for the sys user in the new database."
        },
        "container_configuration":{
            "type":"object",
            "description":"This object specifies that a Container Database is to be created with the PDB settings provided.",
            "items":{
                "type":"object",
                "required":[
                    "number_of_pdbs",
                    "pdb_administrator_password",
                    "pdb_name"
                ],
                "properties":{
                    "number_of_pdbs":{
                        "type":"integer",
                        "description":"The number of Pluggable Databases to create."
                    },
                    "pdb_administrator_password":{
                        "type":"string",
                        "description":"The password for the PDBADMIN user created in each Pluggable Database."
                    },
                    "pdb_name":{
                        "type":"string",
                        "description":"The name prefix to use for each Pluggable Database created."
                    }
                }
            }
        },
        "total_memory":{
            "type":"integer",
            "description":"Total amount of physical memory, in megabytes, that can be used by the new database."
        },
        "username":{
            "type":"string",
            "description":"Specifies the account with SYSDBA role which DBCA will use to delete the database. Only required for DELETE operations."
        },
        "password":{
            "type":"string",
            "description":"Specifies the password for the account with SYSDBA role which DBCA will use to delete the database. Only required for DELETE operations."
        }
    }
}

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

タイプ: object

このオブジェクトは、指定されたPDB設定を使用してコンテナ・データベースを作成することを指定します。

ソースの表示

• 配列: オブジェクト items

{
    "type":"object",
    "description":"This object specifies that a Container Database is to be created with the PDB settings provided.",
    "items":{
        "type":"object",
        "required":[
            "number_of_pdbs",
            "pdb_administrator_password",
            "pdb_name"
        ],
        "properties":{
            "number_of_pdbs":{
                "type":"integer",
                "description":"The number of Pluggable Databases to create."
            },
            "pdb_administrator_password":{
                "type":"string",
                "description":"The password for the PDBADMIN user created in each Pluggable Database."
            },
            "pdb_name":{
                "type":"string",
                "description":"The name prefix to use for each Pluggable Database created."
            }
        }
    }
}

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

タイプ: object

ソースの表示

• number_of_pdbs(required): integer
  作成するプラガブル・データベースの数。
• pdb_administrator_password(required): string
  各プラガブル・データベースに作成されるPDBADMINユーザーのパスワード。
• pdb_name(required): string
  作成される各プラガブル・データベースに使用する名前接頭辞。

{
    "type":"object",
    "required":[
        "number_of_pdbs",
        "pdb_administrator_password",
        "pdb_name"
    ],
    "properties":{
        "number_of_pdbs":{
            "type":"integer",
            "description":"The number of Pluggable Databases to create."
        },
        "pdb_administrator_password":{
            "type":"string",
            "description":"The password for the PDBADMIN user created in each Pluggable Database."
        },
        "pdb_name":{
            "type":"string",
            "description":"The name prefix to use for each Pluggable Database created."
        }
    }
}

例

例の選択 これは、非コンテナ・データベースを作成するためのDBCAジョブを作成する、リクエスト本文の例です。非コンテナ・データベースは、General_Purpose.dbcテンプレートに基づいて、devdb1と呼ばれます。新しいデータベースによって使用される物理メモリーの合計量は、700MBになります。 これは、データベースを削除するためのDBCAジョブを作成する、リクエスト本文の例です。SYSDBAロールがある、データベース内のユーザーの資格証明が提供されます。削除アクションを実行するのにDBCAユーティリティでこれらが必要になるためです。

先頭に戻る

レスポンス

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

• application/json

201レスポンス

新しいDBCAジョブの説明。

本文 ()

ルート・スキーマ: 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"
    ]
}

先頭に戻る

例

次の例は、cURLを使用してRESTリソースに対するPOSTリクエストを発行することによって、指定したOracleホームで新しいDBCAジョブを発行する方法を示しています。DBCAジョブは、指定したOracleホームでデータベースを作成または削除するリクエストにできます。

curl -i -X POST -u username:password 
-d @request_body.json 
-H "Content-Type:application/json" https://rest_server_url/ords/_/db-api/stable/environment/homes/OraDB18Home1/dbca/jobs/

リクエスト本文の例

ノート:

前述のコマンドで使用されるURL構造https://rest_server_url/resource-pathには、次の要素があります。

• rest_server_urlはOracle Rest Data Serverが実行されているRESTサーバーです
• URLの残りの部分には、ORDSコンテキスト・ルート、使用するORDSデータベースAPIのバージョン、およびこの操作のパスが含まれます。OraDB18Home1は、パスのhomeNameパラメータ値として指定されています。すべてのDBCA操作は、Oracleホームで実行されます。

次に、データベースを削除するのDBCAジョブを作成するためのリクエスト本文の例を示します。削除アクションを実行するには、DBCAユーティリティで必要なため、SYSDBAロールを持つデータベース内のユーザーの資格証明を指定する必要があります。

{
  "operation": "DELETE",
  "global_database_name": "devdb1",
  "username": "sys",
  "password": "W3lc0m31"
}

レスポンス・ヘッダーの例

次の例に、レスポンス・ヘッダーを示します。Locationヘッダーは、DBCAジョブのステータスの表示に使用できるURIを返します。

HTTP/1.1 201 Created
Content-Type: application/json
Content-Location: https://rest_server_url/ords/_/db-api/stable/environment/homes/OraDB18Home1/dbca/jobs/RPKlPvbKPKqV7Ap6DN9iRg/
X-Frame-Options: SAMEORIGIN
Location: https://rest_server_url/ords/_/db-api/stable/environment/homes/OraDB18Home1/dbca/jobs/RPKlPvbKPKqV7Ap6DN9iRg/
Transfer-Encoding: chunked

レスポンス本文の例

次の例は、JSON形式で返される201のレスポンス本文を示しています。

{
  "job_id": "RPKlPvbKPKqV7Ap6DN9iRg",
  "description": "Running DBCA to Delete database",
  "status": "RUNNING",
  "submitted": "2019-09-06T19:30:06.981Z",
  "finished": null,
  "job_request": {
    "operation": "DELETE",
    "container_configuration": null,
    "database_system_identifier": null,
    "global_database_name": "devdb1",
    "response_file": null,
    "template_name": null,
    "total_memory": null,
    "username": "sys"
  },
  "dbca_log": [],
  "links": [
    {
      "rel": "self",
      "href": "https://rest_server_url/ords/_/db-api/stable/environment/homes/OraDB18Home1/dbca/jobs/RPKlPvbKPKqV7Ap6DN9iRg/"
    },
    {
      "rel": "describedby",
      "href": "https://rest_server_url/ords/_/db-api/stable/metadata-catalog/"
    },
    {
      "rel": "collection",
      "href": "https://rest_server_url/ords/_/db-api/stable/environment/homes/OraDB18Home1/dbca/jobs/"
    }
  ]
}

先頭に戻る