The VCDBs API from Delphix — 14 operation(s) for vcdbs.
openapi: 3.0.0
info:
title: Delphix DCT Algorithms VCDBs API
version: 3.28.0
description: Delphix DCT API
contact:
name: Delphix Support
url: https://portal.perforce.com/s/
email: support@delphix.com
servers:
- url: /dct/v3
security:
- ApiKeyAuth: []
tags:
- name: VCDBs
paths:
/vcdbs:
get:
summary: List all vCDBs (Oracle only).
operationId: get_vcdbs
tags:
- VCDBs
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/vcdbsSortParam'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: ListVCDBsResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/VCDB'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
/vcdbs/search:
post:
summary: Search for vCDBs (Oracle only).
operationId: search_vcdbs
tags:
- VCDBs
x-filterable:
fields:
id:
type: string
name:
type: string
description:
type: string
database_name:
type: string
database_version:
type: string
environment_id:
type: string
size:
type: integer
engine_id:
type: string
status:
type: string
parent_id:
type: string
creation_date:
type: string
group_name:
type: string
enabled:
type: boolean
content_type:
type: string
namespace_id:
type: string
namespace_name:
type: string
is_replica:
type: boolean
vcdb_restart:
type: boolean
invoke_datapatch:
type: boolean
node_listeners:
type: array[string]
instance_name:
type: string
instance_number:
type: integer
repository_id:
type: string
containerization_state:
type: string
tde_key_identifier:
type: string
tde_keystore_config_type:
type: string
is_tde_keystore_password_set:
type: boolean
database_unique_name:
type: string
db_username:
type: string
redo_log_groups:
type: integer
format: int32
redo_log_size_in_mb:
type: integer
format: int32
nfs_version:
type: integer
format: int32
nfs_version_reason:
type: string
nfs_encryption_enabled:
type: boolean
environment_user_ref:
type: string
db_template_id:
type: string
db_template_name:
type: string
okv_client_id:
type: string
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/vcdbsSortParam'
requestBody:
$ref: '#/components/requestBodies/SearchBody'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: SearchVCDBsResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/VCDB'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
/vcdbs/{vcdbId}:
parameters:
- $ref: '#/components/parameters/vcdbIdParam'
get:
summary: Get a vCDB by ID (Oracle only).
operationId: get_vcdb_by_id
tags:
- VCDBs
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/VCDB'
patch:
tags:
- VCDBs
summary: Update values of a VCDB
operationId: update_vcdb
requestBody:
content:
application/json:
schema:
x-body-name: update_vcdb_parameter
$ref: '#/components/schemas/UpdateVCDBParameters'
description: The parameters to update a VCDB.
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: UpdateVCDBResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/vcdbs/{vcdbId}/tags:
parameters:
- $ref: '#/components/parameters/vcdbIdParam'
post:
tags:
- VCDBs
summary: Create tags for a vCDB.
operationId: create_vcdb_tags
requestBody:
content:
application/json:
schema:
x-body-name: vcdb_tags
$ref: '#/components/schemas/TagsRequest'
description: Tags information for vCDB.
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/TagsResponse'
get:
tags:
- VCDBs
summary: Get tags for a vCDB.
operationId: get_tags_vcdb
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/TagsResponse'
/vcdbs/{vcdbId}/tags/delete:
parameters:
- $ref: '#/components/parameters/vcdbIdParam'
post:
tags:
- VCDBs
summary: Delete tags for a vCDB.
operationId: delete_vcdb_tags
requestBody:
$ref: '#/components/requestBodies/DeleteTags'
responses:
'204':
description: No Content
/vcdbs/{vcdbId}/enable:
parameters:
- $ref: '#/components/parameters/vcdbIdParam'
post:
tags:
- VCDBs
summary: Enable a vCDB.
operationId: enable_vcdb
requestBody:
content:
application/json:
schema:
x-body-name: enable_vcdb_parameter
$ref: '#/components/schemas/EnableVCDBParameters'
description: The parameters to enable a vCDB.
responses:
'200':
description: vCDB enable initiated.
content:
application/json:
schema:
title: EnableVCDBResponse
type: object
properties:
job:
$ref: '#/components/schemas/Job'
/vcdbs/{vcdbId}/disable:
parameters:
- $ref: '#/components/parameters/vcdbIdParam'
post:
summary: Disable a vCDB.
tags:
- VCDBs
operationId: disable_vcdb
requestBody:
content:
application/json:
schema:
x-body-name: disable_vcdb_parameter
$ref: '#/components/schemas/DisableVCDBParameters'
description: The parameters to disable a vCDB.
responses:
'200':
description: vCDB disable initiated.
content:
application/json:
schema:
type: object
title: DisableVCDBResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/vcdbs/{vcdbId}/deletion-dependencies:
parameters:
- $ref: '#/components/parameters/vcdbIdParam'
get:
summary: Get deletion dependencies of a vCDB.
operationId: get_vcdb_deletion_dependencies
tags:
- VCDBs
responses:
'200':
description: Deletion dependencies of a vCDB.
content:
application/json:
schema:
$ref: '#/components/schemas/DeletionDependenciesResponse'
/vcdbs/{vcdbId}/delete:
parameters:
- $ref: '#/components/parameters/vcdbIdParam'
post:
summary: Delete a vCDB.
tags:
- VCDBs
operationId: delete_vcdb
requestBody:
content:
application/json:
schema:
x-body-name: delete_vcdb_parameter
$ref: '#/components/schemas/DeleteVCDBParameters'
description: The parameters to delete a vCDB.
responses:
'200':
description: vCDB delete initiated.
content:
application/json:
schema:
type: object
title: DeleteVCDBResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/vcdbs/{vcdbId}/update:
parameters:
- $ref: '#/components/parameters/vcdbIdParam'
patch:
deprecated: true
summary: Update a VCDB.
tags:
- VCDBs
operationId: update_vcdb_by_id
requestBody:
content:
application/json:
schema:
x-body-name: update_vcdb_parameter
$ref: '#/components/schemas/UpdateVCDBParameters'
description: The parameters to update a VCDB.
responses:
'200':
description: VCDB update initiated.
content:
application/json:
schema:
type: object
title: UpdateVCDBResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/vcdbs/{vcdbId}/start:
parameters:
- $ref: '#/components/parameters/vcdbIdParam'
post:
summary: Start a vCDB.
tags:
- VCDBs
operationId: start_vcdb
requestBody:
content:
application/json:
schema:
x-body-name: StartVcdbParameters
$ref: '#/components/schemas/StartVCDBParameters'
required: false
responses:
'200':
description: vCDB start initiated.
content:
application/json:
schema:
type: object
title: StartVCDBResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/vcdbs/{vcdbId}/stop:
parameters:
- $ref: '#/components/parameters/vcdbIdParam'
post:
summary: Stop a vCDB.
tags:
- VCDBs
operationId: stop_vcdb
requestBody:
content:
application/json:
schema:
x-body-name: StopVcdbParameters
$ref: '#/components/schemas/StopVCDBParameters'
required: false
responses:
'200':
description: vCDB stop initiated.
content:
application/json:
schema:
type: object
title: StopVCDBResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/vcdbs/{vcdbId}/upgrade:
parameters:
- $ref: '#/components/parameters/vcdbIdParam'
post:
summary: Upgrade Oracle vCDB
tags:
- VCDBs
operationId: upgrade_vcdb
requestBody:
content:
application/json:
schema:
x-body-name: upgrade_oracle_vcdb_parameters
$ref: '#/components/schemas/UpgradeOracleContainerDatabaseParameters'
description: The new data to upgrade an Oracle vCDB.
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: UpgradeVCDBResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/vcdbs/{vcdbId}/jdbc-check:
parameters:
- $ref: '#/components/parameters/vcdbIdParam'
post:
tags:
- VCDBs
summary: Verify JDBC connection string for a vCDB.
operationId: verify_vcdb_jdbc_connection_string
requestBody:
$ref: '#/components/requestBodies/OracleVerifyJdbcConnectionStringBody'
responses:
'200':
description: Success or Failure.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectivityCheckResponse'
components:
schemas:
DeletionDependenciesResponse:
description: The deletion dependencies of a dataset.
type: object
properties:
items:
description: The deletion dependencies of a dataset. These are presented in reverse order of deletion meaning that the last item in the list is the first item that needs to be deleted.
type: array
items:
$ref: '#/components/schemas/EngineStorageCapacityDependencyData'
Tag:
type: object
required:
- key
- value
properties:
key:
description: Key of the tag
type: string
minLength: 1
maxLength: 4000
example: key-1
value:
description: Value of the tag
type: string
minLength: 1
maxLength: 4000
example: value-1
EngineStorageDatasetType:
type: string
description: Type of the dataset.
enum:
- VDB
- DSOURCE
- CDB
- VCDB
- HELDSPACE
DisableVCDBParameters:
type: object
description: Parameters to disable a vCDB.
properties:
attempt_cleanup:
type: boolean
description: Whether to attempt a cleanup of the vCDB before the disable.
default: true
VirtualizationTaskEvent:
deprecated: true
properties:
message_details:
type: string
Engine:
properties:
engine_id:
type: string
minLength: 1
maxLength: 4000
engine_name:
type: string
minLength: 1
maxLength: 4000
PaginatedResponseMetadata:
type: object
properties:
prev_cursor:
description: Pointer to the previous page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page.
type: string
next_cursor:
description: Pointer to the next page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page.
type: string
total:
description: The total number of results. This value may not be provided.
type: integer
format: int_64
JobTaskEvent:
properties:
message_details:
type: string
DeleteTag:
type: object
properties:
key:
description: Key of the tag
type: string
minLength: 1
maxLength: 4000
example: key-1
value:
description: Value of the tag
type: string
minLength: 1
maxLength: 4000
example: value-1
tags:
description: List of tags to be deleted
type: array
minItems: 1
maxItems: 1000
uniqueItems: true
items:
$ref: '#/components/schemas/Tag'
OracleActiveInstance:
type: object
properties:
instance_number:
type: integer
description: The number of this instance.
minimum: 1
instance_name:
description: The name of this instance.
type: string
host_name:
type: string
description: The reference to the cluster node which the instance is running on.
JobTask:
properties:
id:
type: string
parent_job_id:
type: string
start_time:
type: string
format: date-time
end_time:
type: string
format: date-time
title:
type: string
percent_complete:
type: integer
minimum: 0
maximum: 100
events:
type: array
items:
$ref: '#/components/schemas/JobTaskEvent'
status:
type: string
enum:
- PENDING
- STARTED
- TIMEDOUT
- RUNNING
- CANCELED
- FAILED
- SUSPENDED
- WAITING
- COMPLETED
- ABANDONED
TagsRequest:
type: object
required:
- tags
properties:
tags:
description: Array of tags with key value pairs
type: array
items:
$ref: '#/components/schemas/Tag'
minItems: 1
maxItems: 1000
uniqueItems: true
StartVCDBParameters:
type: object
description: Parameters to start a vCDB.
properties:
instances:
type: array
items:
type: integer
description: List of specific Virtual Container Database Instances to start.
OracleRACDatabaseInstance:
type: object
required:
- instance_name
- instance_number
- node_reference
properties:
instance_name:
type: string
description: The name of this instance. Must contain at least one non-whitespace character.
minLength: 1
pattern: .*\S.*
instance_number:
type: integer
description: The number of this instance.
minimum: 1
node_reference:
type: string
description: The reference to the cluster node which the instance is running on. Must contain at least one non-whitespace character.
minLength: 1
pattern: .*\S.*
okv_client_id:
description: The id of the OKV client used for TDE keystore access. If provided, it must include at least one non-whitespace character; if omitted, the existing OKV client will be cleared.
type: string
minLength: 1
pattern: .*\S.*
example: 1-ORACLE_OKV_CLIENT-1
OracleCustomEnvVar:
type: object
properties:
cluster_node:
type: string
description: The cluster node on which the environment variable is relevant.
path_parameters:
type: string
description: A string of whitespace-separated parameters to be passed to the source command. The first parameter must be an absolute path to a file that exists on the target environment. Every subsequent parameter will be treated as an argument interpreted by the environment file.
var_name:
type: string
description: The name of the environment variable.
var_value:
description: The value of the environment variable.
type: string
ConnectivityCheckResponse:
title: ConnectivityResponse
type: object
description: The result of the connectivity check.
required:
- message
properties:
message:
description: A message describing the result of the connectivity check.
type: string
example: Success!
status:
description: A status describing the status of the connectivity check.
type: string
enum:
- SUCCESS
- FAILED
example: SUCCESS
OracleService:
properties:
discovered:
description: Represents whether this jdbc connection string is auto discovered or not.
type: boolean
jdbc_connection_string:
description: The jdbc connection string used to connect with the database.
type: string
example: jdbc:oracle:thin:@(DESCRIPTION=(ENABLE=broken)(ADDRESS=(PROTOCOL=tcp)(HOST=10.110.230.197)(PORT=1521))(CONNECT_DATA=(UR=A)(SERVICE_NAME=VDBOMSRBBDC6C_UJG)))
SearchBody:
description: Search body.
type: object
properties:
filter_expression:
type: string
minLength: 5
maxLength: 50000
example: string_field CONTAINS "over" AND numberic_field GT 9000 OR string_field2 EQ "Goku"
VCDB:
description: The Delphix Oracle Virtual Container Database.
type: object
properties:
id:
description: The vCDB object entity ID.
type: string
example: 1-CDB-1
name:
description: The name of this vCDB.
type: string
nullable: true
example: Oracle CDB
description:
description: The container description of this virtual CDB.
type: string
example: This is Oracle virtual CDB.
database_name:
type: string
description: The name of the container database in the Oracle DBMS.
example: VPDBSBBVK4
namespace_id:
description: The namespace id of this vCDB.
type: string
nullable: true
namespace_name:
description: The namespace name of this vCDB.
type: string
nullable: true
is_replica:
description: Is this a replicated object.
type: boolean
nullable: true
database_version:
description: The version of this vCDB.
type: string
nullable: true
example: 10.2.0.5.0
environment_id:
description: A reference to the Environment that hosts this vCDB.
type: string
nullable: true
example: 1-ENVIRONMENT-1
size:
description: The total size of the data files used by this vCDB, in bytes.
type: integer
format: int64
nullable: true
example: 339292672
engine_id:
description: A reference to the Engine that this vCDB belongs to.
type: string
example: engine-12
status:
description: The runtime status of the vCDB.
type: string
nullable: true
example: RUNNING
parent_id:
description: A reference to the parent CDB of this vCDB.
type: string
example: 1-CDB-1
creation_date:
description: The date this vCDB was created.
type: string
format: date-time
nullable: true
example: '2022-10-15T08:51:34.148000+00:00'
group_name:
description: The name of the group containing this vCDB.
type: string
nullable: true
example: Untitled
enabled:
description: Whether the vCDB is enabled or not.
type: boolean
example: true
content_type:
description: The content type of the vcdb.
type: string
nullable: true
vcdb_restart:
description: Indicates whether the Engine should automatically restart this vcdb when target host reboot is detected.
type: boolean
example: true
tags:
type: array
items:
$ref: '#/components/schemas/Tag'
invoke_datapatch:
description: Indicates whether datapatch should be invoked.
type: boolean
node_listeners:
description: The list of node listeners for this VCDB.
type: array
items:
type: string
instance_name:
description: The instance name of this single instance VCDB.
type: string
example: VCDSID
instance_number:
description: The instance number of this single instance VCDB.
type: integer
instances:
type: array
items:
$ref: '#/components/schemas/OracleRACDatabaseInstance'
oracle_services:
type: array
items:
$ref: '#/components/schemas/OracleService'
repository_id:
description: The repository id of this Virtual CDB.
type: string
example: 1-ORACLE_INSTALL-1
containerization_state:
$ref: '#/components/schemas/ContainerizationStateEnum'
example: NOT_CONTAINERIZED
tde_key_identifier:
description: ID of the key created by Delphix, as recorded in v$encryption_keys.key_id.
type: string
example: Ae5Eo6WB208lv+XJfXMTv8sAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
tde_keystore_config_type:
description: The TDE keystore configuration type of this database.
$ref: '#/components/schemas/OracleTdeKeystoreConfigTypeEnum'
example: OKV
is_tde_keystore_password_set:
description: True if TDE keystore password is set for this container database.
type: boolean
database_unique_name:
description: The unique name of the database.
type: string
example: DBOMSRBBDC6C
db_username:
description: The user name of the database.
type: string
example: oracle
logsync_enabled:
x-internal: true
description: True if LogSync is enabled for this VDB.
type: boolean
example: true
archive_log_mode:
x-internal: true
description: True if LogSync is running in archive log mode for this VDB.
type: boolean
example: true
redo_log_groups:
description: Number of Online Redo Log Groups.
type: integer
format: int32
example: 3
redo_log_size_in_mb:
description: Online Redo Log size in MB.
type: integer
format: int32
example: 1024
config_params:
description: Database configuration parameter overrides.
type: object
additionalProperties: true
nullable: true
example:
param: value
param2: value2
custom_env_vars:
type: array
items:
$ref: '#/components/schemas/OracleCustomEnvVar'
active_instances:
type: array
items:
$ref: '#/components/schemas/OracleActiveInstance'
nfs_version:
description: The NFS version that was last used to mount this source."
type: integer
format: int32
example: 3
nfs_version_reason:
description: The reason why the source is being mounted with nfsVersion.
$ref: '#/components/schemas/NfsVersionReasonEnum'
example: DEFAULT
nfs_encryption_enabled:
description: Flag indicating whether the data transfer is encrypted or not.
type: boolean
example: true
environment_user_ref:
description: The environment user reference.
type: string
db_template_id:
description: The database template ID for this Virtual CDB.
type: string
nullable: true
example: DATABASE_TEMPLATE-1
db_template_name:
description: Name of the Database Template.
type: string
nullable: true
example: template-name
okv_client_id:
description: The id of the OKV client used for TDE keystore access.
type: string
example: 1-ORACLE_OKV_CLIENT-1
engine_container_reference:
x-internal: true
description: Reference to the engine container.
type: string
ContainerizationStateEnum:
type: string
description: Indicates the virtual database's containerization state, created for or running inside a containerized environment like Linux containers.
enum:
- NOT_CONTAINERIZED
- READY_FOR_CONTAINER
- RUNNING_IN_CONTAINER
DeleteVCDBParameters:
type: object
description: Parameters to delete a vCDB.
properties:
force:
type: boolean
description: Whether to continue the operation upon failures.
default: false
delete_all_dependent_datasets:
type: boolean
description: Whether to delete all dependent datasets of the CDB.
default: false
OracleRacCustomEnvFile:
type: object
properties:
node_id:
type: string
minLength: 1
maxLength: 256
path_parameters:
type: string
VirtualizationTask:
deprecated: true
properties:
id:
type: string
parent_job_id:
type: string
start_time:
type: string
format: date-time
end_time:
type: string
format: date-time
title:
type: string
percent_complete:
type: integer
minimum: 0
maximum: 100
events:
type: array
items:
$ref: '#/components/schemas/VirtualizationTaskEvent'
status:
type: string
enum:
- PENDING
- STARTED
- TIMEDOUT
- RUNNING
- CANCELED
- FAILED
- SUSPENDED
- WAITING
- COMPLETED
- ABANDONED
EngineStorageCapacityData:
properties:
engine_id:
type: string
description: ID of the engine.
dataset_id:
type: string
description: ID of the dataset.
captured_timestamp:
type: string
format: date-time
description: Time at which this information was sampled.
dataset_type:
description: Type of the dataset.
$ref: '#/components/schemas/EngineStorageDatasetType'
dataset_name:
type: string
description: Name of the dataset.
is_replica:
type: boolean
description: Flag to specify if this object is a replica.
total_size:
type: integer
format: int64
description: Actual space used by the dataset.
base_size:
type: integer
format: int64
description: Amount of space used for the active copy of the dataset.
snapshot_size:
type: integer
format: int64
description: Amount of space used by snapshots.
logs_size:
type: integer
format: int64
description: Amount of space used by logs.
unvirtualized_size:
type: integer
format: int64
description: Unvirtualized space used by the dataset.
current_timeflow_unvirtualized_size:
type: integer
format: int64
description: Unvirtualized space used by the current (active) TimeFlow. This is approximately equal to the space a VDB would take upon a virtual-to-physical (V2P) operation.
timeflow_unvirtualized_size:
type: integer
format: int64
description: Unvirtualized space used by the TimeFlow.
descendant_size:
type: integer
format: int64
description: Amount of space used for snapshots from which VDBs have been provisioned.
policy_size:
type: integer
format: int64
description: Amount of space used for snapshots held by policy settings.
manual_size:
type: integer
format: int64
description: Amount of space used for snapshots held by manual retention settings.
unowned_snapshot_size:
type: integer
format: int64
description: Amount of space used for snapshots part of held space.
ingested_size:
type: integer
format: int64
description: Amount of space ingested by the source.
tags:
description: The tags that are applied to dataset.
type: array
items:
$ref: '#/components/schemas/Tag'
discriminator:
propertyName: class_type
EnableVCDBParameters:
type: object
description: Parameters to enable a vCDB.
properti
# --- truncated at 32 KB (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/delphix/refs/heads/main/openapi/delphix-vcdbs-api-openapi.yml