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. properties: attempt_start: type: boolean description: Whether to attempt a startup of the vCDB after the enable. default: true UpdateVCDBParameters: type: object description: Parameters to update a VCDB. properties: oracle_services: type: array items: type: string description: List of jdbc connection strings which are used to connect with the database. example: - jdbc:oracle:thin:@hostname:port/service_name - jdbc:oracle:thin:@hostname:port:SID okv_client_id: description: The id of the OKV client used for TDE keystore access. A blank string will unset the existing OKV client id. type: string example: 1-ORACLE_OKV_CLIENT-1 instance_name: description: The instance name of this single instance CDB. Must contain at least one non-whitespace character. type: string minLength: 1 pattern: .*\S.* example: CDBSID instance_number: description: The instance number of this single instance CDB. type: integer minimum: 1 example: 1 instances: type: array description: The instances of this RAC database. items: $ref: '#/components/schemas/OracleRACDatabaseInstance' minItems: 1 example: - instance_name: instance1 instance_number: 1 node_reference: ORACLE_CLUSTER_NODE-1 okv_client_id: 1-ORACLE_OKV_CLIENT-1 node_listeners: description: The list of node listener ids for this VCDB. type: array items: type: string example: - 1-ORACLE_NODE_LISTENER-2 - 1-ORACLE_NODE_LISTENER-3 invoke_datapatch: description: Indicates whether datapatch should be invoked. type: boolean tde_keystore_password: x-dct-toolkit-credential-field: true description: For a vCDB using software keystore, this is the password of the software keystore used by this database. For a vCDB using OKV, this is the password for the endpoint provided during the installation of the Oracle Key Vault client library (i.e., okvclient.jar) on the host where this database runs. For a vCDB using HSM, this is the credential of the external key manager which is managing master encryption keys of this database. A blank string will unset the existing tde keystore password. type: string maxLength: 128 example: password tde_keystore_config_type: description: The TDE keystore configuration type of this database. $ref: '#/components/schemas/OracleTdeKeystoreConfigTypeEnum' example: OKV tde_key_identifier: description: The master encryption key id of this database. A blank string will unset the existing tde key identifier. type: string maxLength: 78 example: 0692EFF441BB604F82BFDAD4D2D4181B30 db_username: type: string description: The username of the database user. minLength: 1 maxLength: 256 example: db-username db_password: x-dct-toolkit-credential-field: true type: string description: The password of the database user. minLength: 1 maxLength: 256 example: db-password auto_restart: type: boolean description: Whether to enable VDB restart. environment_user_id: type: string description: The environment user ID to use to connect to the target environment. minLength: 1 maxLength: 256 example: environment-user-123 config_params: description: Database configuration parameter overrides. type: object additionalProperties: true example: processes: 150 custom_env_vars: description: Environment variable to be set when the engine administers a VCDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution. Custom environment variables can only be updated while the VCDB is disabled. type: object additionalProperties: type: string minLength: 1 maxLength: 4096 example: MY_ENV_VAR1: $ORACLE_HOME MY_ENV_VAR2: $CRS_HOME/after custom_env_files: description: Environment files to be sourced when the Engine administers a VCDB. This path can be followed by parameters. Paths and parameters are separated by spaces. Custom environment variables can only be updated while the VCDB is disabled. type: array items: type: string minLength: 1 maxLength: 4096 example: - /export/home/env_file_1 - /export/home/env_file_2 oracle_rac_custom_env_files: description: Environment files to be sourced when the Engine administers an Oracle RAC VCDB. This path can be followed by parameters. Paths and parameters are separated by spaces. Custom environment variables can only be updated while the VCDB is disabled. type: array items: $ref: '#/components/schemas/OracleRacCustomEnvFile' example: - node_id: ORACLE_CLUSTER_NODE-1 path_parameters: /export/home/env_file_1 oracle_rac_custom_env_vars: description: Environment variable to be set when the engine administers an Oracle RAC VCDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution. Custom environment variables can only be updated while the VCDB is disabled. type: array items: $ref: '#/components/schemas/OracleRacCustomEnvVar' example: - node_id: ORACLE_CLUSTER_NODE-1 name: MY_ENV_VAR1 value: $CRS_HOME/after description: description: The container description of this virtual CDB. type: string example: Updated virtual CDB description. db_template_id: type: string description: The ID of the target Virtual CDB Template. maxLength: 256 example: template-123 OracleTdeKeystoreConfigTypeEnum: type: string description: Oracle TDE keystore configuration type. enum: - FILE - OKV - HSM - OKV|FILE - FILE|OKV - HSM|FILE - FILE|HSM - OCI_VAULT - UNSET TagsResponse: type: object properties: tags: description: Array of tags with key value pairs type: array items: $ref: '#/components/schemas/Tag' OracleVerifyJdbcConnectionStringParams: type: object required: - database_username - database_password - jdbc_connection_string properties: database_username: type: string description: oracle database username. example: oracle database_password: x-dct-toolkit-credential-field: true type: string description: oracle database password. example: oracle jdbc_connection_string: type: string description: Oracle jdbc connection string to validate. example: jdbc:oracle:thin:@(DESCRIPTION=(ENABLE=broken)(ADDRESS=(PROTOCOL=tcp)(HOST=10.110.219.71)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=CDOMLOSR25E9PDB1))) OracleRacCustomEnvVar: type: object properties: node_id: type: string minLength: 1 maxLength: 256 name: type: string minLength: 1 maxLength: 4096 value: type: string minLength: 1 maxLength: 4096 StopVCDBParameters: type: object description: Parameters to stop a vCDB. properties: instances: type: array items: type: integer description: List of specific Virtual Container Database Instances to stop. abort: type: boolean description: Whether to issue 'shutdown abort' to shutdown Virtual Container DB instances. default: false NfsVersionReasonEnum: type: string description: The reason why the source is being mounted with nfsVersion. enum: - DEFAULT - OLD_REDHAT - UNSUPPORTED_OS - DNFS - TUNABLE_OVERRIDE - NO_RECOVER_LOST_LOCKS - UNSUPPORTED_DATA_PLATFORM - INCOMPLETE_V4_CONFIG - DNFS_UNSUPPORTED_ORACLE_VERSIONS_1912_1915 - DNFS_UNSUPPORTED_ORACLE_VERSIONS_211_216 - DNFS_UNSUPPORTED_ORACLE_VERSIONS_LESS_THAN_12C EngineStorageCapacityDependencyData: description: Engine storage capacity dependency data. allOf: - $ref: '#/components/schemas/EngineStorageCapacityData' - type: object properties: parent_id: type: string description: ID of the parent dataset. Job: description: An asynchronous task. type: object properties: id: description: The Job entity ID. type: string example: job-123 status: description: The status of the job. type: string enum: - PENDING - STARTED - TIMEDOUT - RUNNING - CANCELED - FAILED - SUSPENDED - WAITING - COMPLETED - ABANDONED example: RUNNING is_waiting_for_telemetry: description: Indicates that the operations performed by this Job have completed successfully, but the object changes are not yet reflected. This is only set when when the JOB is in STARTED status, with the guarantee that the job will not transition to the FAILED status. Note that this flag will likely be replaced with a new status in future API versions and be deprecated. type: boolean type: description: The type of job being done. type: string example: DB_REFRESH localized_type: description: The i18n translated type of job being done. type: string example: DB Refresh error_details: description: Details about the failure for FAILED jobs. type: string example: Unable to connect to the engine. warning_message: description: Warnings for the job. type: string example: 'Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.' target_id: description: A reference to the job's target. type: string example: vdb-123 target_name: description: A reference to the job's target name. type: string example: vdb start_time: description: The time the job started executing. type: string format: date-time example: '2022-01-02T05:11:24.148000+00:00' update_time: description: The time the job was last updated. type: string format: date-time example: '2022-01-02T06:11:24.148000+00:00' trace_id: description: traceId of the request which created this Job type: string engine_ids: description: IDs of the engines this Job is executing on. type: array items: type: string deprecated: true tags: type: array items: $ref: '#/components/schemas/Tag' engines: type: array items: $ref: '#/components/schemas/Engine' account_id: description: The ID of the account who initiated this job. type: integer example: 1 account_name: description: The account name which initiated this job. It can be either firstname and lastname combination or firstname or lastname or username or email address or Account-. type: string example: User 1 compliance_node_id: description: The ID of the associated compliance node, if applicable. type: string nullable: true compliance_node_name: description: The name of the associated compliance node, if applicable. type: string nullable: true percent_complete: description: Completion percentage of the Job. type: integer minimum: 0 maximum: 100 example: '50' virtualization_tasks: deprecated: true type: array items: $ref: '#/components/schemas/VirtualizationTask' tasks: type: array items: $ref: '#/components/schemas/JobTask' execution_id: description: The ID of the associated masking execution, if any. type: string nullable: true result_type: description: The type of the job result. This is the type of the object present in the result. type: string result: description: The result of the job execution. This is JSON serialized string of the result object whose type is specified by result_type property. type: object discriminator: propertyName: class_type UpgradeOracleContainerDatabaseParameters: type: object description: Parameters to upgrade CDB/vCDB. required: - repository_id - environment_user_id properties: repository_id: type: string description: The id of the CDB/vCDB repository to upgrade to. example: 1-ORACLE_INSTALL-4 environment_user_id: type: string description: Reference of the environment user to use for CDB/vCDB upgrade. example: HOST_USER-4 requestBodies: OracleVerifyJdbcConnectionStringBody: description: The parameters to verify oracle jdbc connection string. content: application/json: schema: x-body-name: oracle_verify_jdbc_connection_parameters $ref: '#/components/schemas/OracleVerifyJdbcConnectionStringParams' SearchBody: x-skip-codegen-attr: description description: 'A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview **Note: All keywords are case-insensitive** ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS ''foobar'', field4 CONTAINS TRUE | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN [''Goku'', ''Vegeta''] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 | ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH ''12''` would match an item with an attribute with an integer value of `123`. ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ ''Goku'' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ ''Goku'' | ## Grouping Parenthesis `()` can be used to override operator precedence. For example: NOT (field1 LT 1234 AND field2 CONTAINS ''foo'') ## Literal Values | Literal | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | "foo", "bar", "foo bar", ''foo'', ''bar'', ''foo bar'' | | Datetime | Formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], [''foo'', "bar"] | ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. ' content: application/json: schema: $ref: '#/components/schemas/SearchBody' examples: nested: description: 'An example of a nested Object comparison testing that at least one repository has a version which is equal to 19.0.0. ' summary: Nested Object Comparison value: filter_expression: repositories CONTAINS {version eq '19.0.0'} relative: description: 'An example of a relative comparison testing that field1 has a value which is less than 123. ' summary: Relative comparison value: filter_expression: field1 LE 123 nil: description: 'An example of using nil to test for the absence of a value for field2. ' summary: Absence of an attribute value value: filter_expression: field2 EQ NIL non-nil: description: 'An example of using nil to test for the existence of a value for field2. ' summary: Existence of an attribute value value: filter_expression: field2 NE NIL contains: description: 'An example of using the ''CONTAINS'' operator to check if field2 contains the string ''foo''. If field2 is string valued then this is checking if ''foo'' is a substring of field2. If field2 is a list of strings then this is checking if ''foo'' is a member of the list. ' summary: Use of the CONTAINS operator value: filter_expression: field2 CONTAINS 'foo' in: description: 'An example of using the ''IN'' operator to check if field1 is an element of a list literal. ' summary: Use of the IN operator value: filter_expression: field1 IN [1, 2, 3] search: description: 'An example of using the ''SEARCH'' operator to retrieve all elements for which ''foo'' is a substring of a filterable attribute. ' summary: Use of the SEARCH operator value: filter_expression: SEARCH 'foo' parenthesis: description: 'An example of parenthesis being used to group operators & override operator precedence. ' summary: Overriding operator precedence value: filter_expression: field1 LT 1234 AND (field2 CONTAINS 'foo' OR field3 CONTAINS 'bar') DeleteTags: description: The parameters to delete tags content: application/json: schema: x-body-name: environment $ref: '#/components/schemas/DeleteTag' examples: delete_all_tags: description: Delete all tags for given object - No request body required summary: Delete all tags value: {} delete_tags_by_key: description: Delete all tags for given object with matching key summary: Delete tags by key value: key: key-1 delete_tags_by_key_value: description: Delete tag for given object with matching key and value summary: Delete a tag by key & value value: key: key-1 value: value-1 delete_multiple_tags_by_key_value: description: Delete tags for given list of tags with matching key and value summary: Delete multiple tags by key & value value: tags: - key: key-1 value: value-1 - key: key-2 value: value-2 parameters: vcdbIdParam: in: path name: vcdbId required: true schema: type: string minLength: 1 description: The ID of the vCDB. limit: name: limit in: query description: Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. example: 50 schema: type: integer minimum: 1 maximum: 1000 default: 100 cursor: name: cursor in: query description: Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. schema: type: string minLength: 1 maxLength: 4096 vcdbsSortParam: name: sort in: query description: The field to sort results by. A property name with a prepended '-' signifies descending order. example: id required: false schema: type: string enum: - id - -id - name - -name - database_name - -database_name - database_version - -database_version - environment_id - -environment_id - size - -size - engine_id - -engine_id - status - -status - parent_id - -parent_id - creation_date - -creation_date - group_name - -group_name - enabled - -enabled - invoke_datapatch - -invoke_datapatch - instance_name - -instance_name - instance_number - -instance_number - repository_id - -repository_id - containerization_state - -containerization_state - tde_key_identifier - -tde_key_identifier - tde_keystore_config_type - -tde_keystore_config_type - is_tde_keystore_password_set - -is_tde_keystore_password_set - database_unique_name - -database_unique_name - db_username - -db_username - redo_log_groups - -redo_log_groups - redo_log_size_in_mb - -redo_log_size_in_mb - nfs_version - -nfs_version - nfs_version_reason - -nfs_version_reason - nfs_encryption_enabled - -nfs_encryption_enabled - description - -description - environment_user_ref - -environment_user_ref - db_template_id - -db_template_id - db_template_name - -db_template_name - okv_client_id - -okv_client_id nullable: true example: name securitySchemes: ApiKeyAuth: type: apiKey in: header name: Authorization