REST APIs for Oracle Database

Clone or Unplug operations for PDBs

post

/database/pdbs/{pdb_name}/

Clone or Unplug a PDB. These operations have a significant impact on the specified pluggable databases. The unplug operation will delete the PDB. Note that when cloning a pluggable database, the state of the source database will temporarily be set to OPEN READ ONLY for the duration of the operation and reset to its original state. The use of of Oracle Transparent Data Encryption is only supported in topologies where the database and Oracle REST Data Services are on the same host. This service requires db.cdb.adminUser credentials to be set in the pool configuration.

Request

Supported Media Types

application/json

Path Parameters

pdb_name: string

Name of the Pluggable Database to clone from or unplug.

Root Schema : schema

Type: object

Show Source

clonePDBName(optional): string

The name of the new clone PDB. Required when method is specified as CLONE.
fileNameConversions(optional): string

Relevant for clone operations. As defined in the Oracle Multitenant Database documentation.
getScript(optional): boolean

If defined, the response will contain a JSON object with the information of the script that was generated for execution. No action is taken when this property is true and only the script text is returned.
method: string

Allowed Values: [ "CLONE", "UNPLUG" ]

This property defines the type of operation. Note that CLONE may change the state of the source PDB and UNPLUG will result in the PDB being dropped.
pdb_name(optional): string

Source PDB in case of clone or the PDB to be unplugged in case of an unplug operation. This property is optional and the name defined in the URI takes priority.
reuseTempFile(optional): boolean

Relevant for clone operations. True for temporary file reusage.
sparseClonePath(optional): string

A Path specified for sparse clone snapshot copy. (Optional)
tdeExport(optional): boolean

TDE export for unplug operations.
tdeKeystorePath(optional): string

TDE keystore path is required if the tdeExport flag is set to true. Can be used in unplug operations only.
tdePassword(optional): string

TDE password for unplug operations only. This is required when the tdeExport flag is set to true.
tdeSecret(optional): string

TDE secret is required if the tdeExport flag is set to true. Can be used in unplug operations only.
tempSize(optional): string

Relevant for clone operations. Size of the temporary tablespace. See size_clause description in Database SQL Language Reference documentation.
totalSize(optional): string

Relevant for clone operations. Size of the tablespace. See size_clause description in Database SQL Language Reference documentation.
unlimitedStorage(optional): boolean

Relevant for clone operations. True for unlimited storage. Even when set to true, totalSize and tempSize MUST be specified in the request if method is CLONE.
xmlFileName(optional): string

Relevant for Unplug operations.

{
    "type":"object",
    "required":[
        "method"
    ],
    "properties":{
        "method":{
            "type":"string",
            "description":"This property defines the type of operation. Note that CLONE may change the state of the source PDB and UNPLUG will result in the PDB being dropped.",
            "enum":[
                "CLONE",
                "UNPLUG"
            ]
        },
        "pdb_name":{
            "type":"string",
            "description":"Source PDB in case of clone or the PDB to be unplugged in case of an unplug operation. This property is optional and the name defined in the URI takes priority."
        },
        "sparseClonePath":{
            "type":"string",
            "description":"A Path specified for sparse clone snapshot copy. (Optional)"
        },
        "clonePDBName":{
            "type":"string",
            "description":"The name of the new clone PDB. Required when method is specified as CLONE."
        },
        "fileNameConversions":{
            "type":"string",
            "description":"Relevant for clone operations. As defined in the Oracle Multitenant Database documentation."
        },
        "unlimitedStorage":{
            "type":"boolean",
            "description":"Relevant for clone operations. True for unlimited storage. Even when set to true, totalSize and tempSize MUST be specified in the request if method is CLONE."
        },
        "reuseTempFile":{
            "type":"boolean",
            "description":"Relevant for clone operations. True for temporary file reusage."
        },
        "totalSize":{
            "type":"string",
            "description":"Relevant for clone operations. Size of the tablespace. See size_clause description in Database SQL Language Reference documentation."
        },
        "tempSize":{
            "type":"string",
            "description":"Relevant for clone operations. Size of the temporary tablespace. See size_clause description in Database SQL Language Reference documentation."
        },
        "xmlFileName":{
            "type":"string",
            "description":"Relevant for Unplug operations."
        },
        "tdeExport":{
            "type":"boolean",
            "description":"TDE export for unplug operations."
        },
        "tdePassword":{
            "type":"string",
            "description":"TDE password for unplug operations only. This is required when the tdeExport flag is set to true."
        },
        "tdeKeystorePath":{
            "type":"string",
            "description":"TDE keystore path is required if the tdeExport flag is set to true. Can be used in unplug operations only."
        },
        "tdeSecret":{
            "type":"string",
            "description":"TDE secret is required if the tdeExport flag is set to true. Can be used in unplug operations only."
        },
        "getScript":{
            "type":"boolean",
            "description":"If defined, the response will contain a JSON object with the information of the script that was generated for execution. No action is taken when this property is true and only the script text is returned."
        }
    }
}

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