Oracle Database REST API

PDBの状態の変更

POST

/database/pdbs/{pdb_name}/status

プラガブル・データベースの状態を変更します。データベースで実行されるALTER PLUGGABLE DATABASEコマンドにはINSTANCES=ALL句が含まれているため、Oracle Real Application Clusters環境では、すべてのインスタンスにおいてプラガブル・データベースの状態が変更されます。このサービスでは、プール構成でdb.cdb.adminUser資格証明を設定する必要があります。クライアントは、このサービスを起動するにはSQL管理者ロールが必要です。

リクエスト

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

application/json

パス・パラメータ

pdb_name: string

プラガブル・データベースの名前。

ルート・スキーマ: schema

タイプ: object

ソースの表示

getScript(optional): boolean

定義した場合、レスポンスにはJSONオブジェクトが含まれます。これには実行のために生成されたスクリプトの情報が含まれます。状態の変更は発生しません。
modifyOption: string

指定できる値: [ "IMMEDIATE", "NORMAL", "READ ONLY", "READ WRITE", "RESTRICTED" ]

PDBをオープンおよびクローズするための追加オプション。
state: string

指定できる値: [ "OPEN", "CLOSE" ]

PDBのターゲットの状態。

{
    "type":"object",
    "required":[
        "state",
        "modifyOption"
    ],
    "properties":{
        "state":{
            "type":"string",
            "description":"The target state of the PDB.",
            "enum":[
                "OPEN",
                "CLOSE"
            ]
        },
        "modifyOption":{
            "type":"string",
            "description":"Extra options for opening and closing a PDB.",
            "enum":[
                "IMMEDIATE",
                "NORMAL",
                "READ ONLY",
                "READ WRITE",
                "RESTRICTED"
            ]
        },
        "getScript":{
            "type":"boolean",
            "description":"If defined, the response will contain a JSON object with the information of the script that was generated for execution. The change of state does not happen."
        }
    }
}

先頭に戻る

レスポンス

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

application/json

200 レスポンス

レスポンスは一連のPL/SQL文の実行が成功したことを示すか、プラガブル・データベースを作成するために実行される一連のPL/SQL文を返します。

ルート・スキーマ : RESTSQLCollection

タイプ: object

ソースの表示

env(optional): string
items(optional): array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SQLItem"
            }
        },
        "env":{
            "type":"string"
        }
    }
}

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

タイプ: array

ソースの表示

配列: オブジェクト SQLItem

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

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

タイプ: object

ソースの表示

response(optional): array response
result(optional): integer
statementId(optional): integer

{
    "type":"object",
    "properties":{
        "statementId":{
            "type":"integer"
        },
        "response":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "result":{
            "type":"integer"
        }
    }
}

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

タイプ: array

ソースの表示

配列: 文字列

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

先頭に戻る

例

次の例は、cURLを使用してRESTリソースに対するPOSTリクエストを発行することによって、プラガブル・データベースをオープンまたはクローズする方法を示しています。

curl -i -X POST -u username:password 
-d @request_body.json 
-H "Content-Type:application/json" https://rest_server_url/ords/_/db-api/stable/database/pdbs/devpdb1/status

リクエスト本文の例

ノート:

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

rest_server_urlはOracle Rest Data Serverが実行されているRESTサーバーです
URLの残りの部分には、ORDSコンテキスト・ルート、使用するORDSデータベースAPIのバージョン、この操作のパスおよびPDB識別子devpdb1が含まれます。この例では、pdb_nameパス・パラメータはdevpdb1です。PDBライフサイクル管理サービスでは、db.cdb.adminUserの資格証明をプール構成に設定する必要があり、この例では、コンテナ・データベースに対してデフォルト・プールが構成されています。

次に、URLのpdb_nameパラメータで指定されたプラガブル・データベースをクローズするためのリクエスト本文の例を示します。

{
  "state": "CLOSE",
  "modifyOption": "IMMEDIATE"
}

次に、URLのpdb_nameパラメータで指定されたデータベースをオープンするためのリクエスト本文の例を示します。modifyOptionパラメータはすべての場合に必須であるため、デフォルトのオープン・モードを適用できるように、値はNORMALに設定されます。

{
  "state": "OPEN",
  "modifyOption": "NORMAL"
}

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

次の例に、レスポンス・ヘッダーを示します。

HTTP/1.1 200 OK
Date: Thu, 05 Sep 2019 12:21:01 PDT
Content-Type: application/json
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked

レスポンス本文の例

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

{
  "env":{"defaultTimeZone":"PST8PDT"},
  "items":[
    {
      "statementId":1,
      "response":["\nPL\/SQL procedure successfully completed.\n\n"],
      "result":0
    }
  ]
}

先頭に戻る