Oracleホームでの新しいDBCAジョブの作成
POST
/environment/homes/{homeName}/dbca/jobs/
指定されたOracleホームでデータベースをCREATEまたはDELETEするための新しいDBCAジョブ・リクエストを発行します。このOracleホームは、Oracle REST Data Servicesサーバー・インスタンスと同じホスト上にある必要があります。クライアントは、このサービスを起動するにはシステム管理者ロールが必要です。
リクエスト
サポートされるメディア・タイプ
- application/json
パス・パラメータ
- homeName: string
Oracleホームの名前。
レスポンス
サポートされるメディア・タイプ
- application/json
201レスポンス
新しいDBCAジョブの説明。
ルート・スキーマ: EnvironmentDbcaJobsItem
タイプ:
object
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
DBCAジョブ・リクエストについて説明する
- links(optional): array links
- status(optional): string
DBCAジョブのステータス
- submitted(optional): string
DBCAジョブ・リクエストが発行された時点のタイムスタンプ
ネストされたスキーマ: job_request
タイプ:
object
DBCAジョブ・リクエストについて説明する
ソースの表示
- container_configuration(optional): object container_configuration
このオブジェクトは、CDBのコンテナ構成詳細を表します。
- 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ユーザー名
ネストされたスキーマ : container_configuration
タイプ:
object
このオブジェクトは、CDBのコンテナ構成詳細を表します。
ソースの表示
- number_of_pdbs(optional): string
作成するPDBの数
- pdb_name(optional): string
各PDBのベース名。number_of_pdbsが1よりも大きい場合は、それぞれの名前に番号が追加される。
例
次の例は、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/"
}
]
}