REST APIs for Oracle Database

Change the state of a PDB

post

/database/pdbs/{pdb_name}/status

Changes the state of a pluggable database.

Request

Supported Media Types

application/json

Path Parameters

pdb_name: string

Name of the Pluggable Database.

Root Schema : schema

Type: object

Show Source

getScript(optional): boolean

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.
modifyOption: string

Allowed Values: [ "IMMEDIATE", "NORMAL", "READ ONLY", "READ WRITE", "RESTRICTED" ]

Extra options for opening and closing a PDB.
state: string

Allowed Values: [ "OPEN", "CLOSE" ]

The target state of the 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."
        }
    }
}

Response

Supported Media Types

application/json

200 Response

The response will indicate the successful execution of a series of PL/SQL statements, or return a set of PL/SQL statements that could be executed to create a pluggable database.

Root Schema : RESTSQLCollection

Type: object

Show Source

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

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

Nested Schema : items

Type: array

Show Source

Array of: object SQLItem

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

Nested Schema : SQLItem

Type: object

Show Source

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"
        }
    }
}

Nested Schema : response

Type: array

Show Source

Array of: string

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