Database Tools Functions

ADD_DATABASE_TOOLS_CONNECTION_LOCK Function

Adds a lock to a DatabaseToolsConnection resource.

Syntax

FUNCTION add_database_tools_connection_lock (
  database_tools_connection_id varchar2,
  add_resource_lock_details dbms_cloud_oci_database_tools_add_resource_lock_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dt_database_tools_add_database_tools_connection_lock_response_t;

Parameters

Parameter	Description
`database_tools_connection_id`	(required) The OCID of a Database Tools connection.
`add_resource_lock_details`	(required) AddResourceLockDetails body parameter
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbtools.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

ADD_DATABASE_TOOLS_PRIVATE_ENDPOINT_LOCK Function

Adds a lock to a DatabaseToolsPrivateEndpoint resource.

Syntax

FUNCTION add_database_tools_private_endpoint_lock (
  database_tools_private_endpoint_id varchar2,
  add_resource_lock_details dbms_cloud_oci_database_tools_add_resource_lock_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dt_database_tools_add_database_tools_private_endpoint_lock_response_t;

Parameters

Parameter	Description
`database_tools_private_endpoint_id`	(required) The OCID of a Database Tools private endpoint.
`add_resource_lock_details`	(required) AddResourceLockDetails body parameter
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbtools.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_DATABASE_TOOLS_CONNECTION_COMPARTMENT Function

Moves the specified Database Tools connection to a different compartment in the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Syntax

FUNCTION change_database_tools_connection_compartment (
  database_tools_connection_id varchar2,
  change_database_tools_connection_compartment_details dbms_cloud_oci_database_tools_change_database_tools_connection_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  is_lock_override number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dt_database_tools_change_database_tools_connection_compartment_response_t;

Parameters

Parameter	Description
`database_tools_connection_id`	(required) The OCID of a Database Tools connection.
`change_database_tools_connection_compartment_details`	(required) Request to change the compartment of the DatabaseToolsConnection.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`is_lock_override`	(optional) Whether to override locks (if any exist).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbtools.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_DATABASE_TOOLS_PRIVATE_ENDPOINT_COMPARTMENT Function

Moves a Database Tools private endpoint into a different compartment in the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Syntax

FUNCTION change_database_tools_private_endpoint_compartment (
  database_tools_private_endpoint_id varchar2,
  change_database_tools_private_endpoint_compartment_details dbms_cloud_oci_database_tools_change_database_tools_private_endpoint_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  is_lock_override number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dt_database_tools_change_database_tools_private_endpoint_compartment_response_t;

Parameters

Parameter	Description
`database_tools_private_endpoint_id`	(required) The OCID of a Database Tools private endpoint.
`change_database_tools_private_endpoint_compartment_details`	(required) Request to change the compartment of the DatabaseToolsPrivateEndpoint.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`is_lock_override`	(optional) Whether to override locks (if any exist).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbtools.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_DATABASE_TOOLS_CONNECTION Function

Creates a new Database Tools connection.

Syntax

FUNCTION create_database_tools_connection (
  create_database_tools_connection_details dbms_cloud_oci_database_tools_create_database_tools_connection_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dt_database_tools_create_database_tools_connection_response_t;

Parameters

Parameter	Description
`create_database_tools_connection_details`	(required) Details for the new `DatabaseToolsConnection`.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. Accepted characters: ASCII alphanumerics plus underscore (U+005F LOW LINE \"_\") and dash (U+002D HYPHEN-MINUS \"-\")
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbtools.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_DATABASE_TOOLS_PRIVATE_ENDPOINT Function

Creates a new Database Tools private endpoint.

Syntax

FUNCTION create_database_tools_private_endpoint (
  create_database_tools_private_endpoint_details dbms_cloud_oci_database_tools_create_database_tools_private_endpoint_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dt_database_tools_create_database_tools_private_endpoint_response_t;

Parameters

Parameter	Description
`create_database_tools_private_endpoint_details`	(required) Details for the new DatabaseToolsPrivateEndpoint.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. Accepted characters: ASCII alphanumerics plus underscore (U+005F LOW LINE \"_\") and dash (U+002D HYPHEN-MINUS \"-\")
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbtools.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_DATABASE_TOOLS_CONNECTION Function

Deletes the specified Database Tools connection resource.

Syntax

FUNCTION delete_database_tools_connection (
  database_tools_connection_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  is_lock_override number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dt_database_tools_delete_database_tools_connection_response_t;

Parameters

Parameter	Description
`database_tools_connection_id`	(required) The OCID of a Database Tools connection.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`is_lock_override`	(optional) Whether to override locks (if any exist).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbtools.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_DATABASE_TOOLS_PRIVATE_ENDPOINT Function

Deletes the specified Database Tools private endpoint.

Syntax

FUNCTION delete_database_tools_private_endpoint (
  database_tools_private_endpoint_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  is_lock_override number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dt_database_tools_delete_database_tools_private_endpoint_response_t;

Parameters

Parameter	Description
`database_tools_private_endpoint_id`	(required) The OCID of a Database Tools private endpoint.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`is_lock_override`	(optional) Whether to override locks (if any exist).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbtools.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_DATABASE_TOOLS_CONNECTION Function

Gets details of the specified Database Tools connection.

Syntax

FUNCTION get_database_tools_connection (
  database_tools_connection_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dt_database_tools_get_database_tools_connection_response_t;

Parameters

Parameter	Description
`database_tools_connection_id`	(required) The OCID of a Database Tools connection.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbtools.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_DATABASE_TOOLS_ENDPOINT_SERVICE Function

Gets details for the specified Database Tools endpoint service.

Syntax

FUNCTION get_database_tools_endpoint_service (
  database_tools_endpoint_service_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dt_database_tools_get_database_tools_endpoint_service_response_t;

Parameters

Parameter	Description
`database_tools_endpoint_service_id`	(required) The OCID of a Database Tools Endpoint Service.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbtools.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_DATABASE_TOOLS_PRIVATE_ENDPOINT Function

Gets details of a specified Database Tools private endpoint.

Syntax

FUNCTION get_database_tools_private_endpoint (
  database_tools_private_endpoint_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dt_database_tools_get_database_tools_private_endpoint_response_t;

Parameters

Parameter	Description
`database_tools_private_endpoint_id`	(required) The OCID of a Database Tools private endpoint.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbtools.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_WORK_REQUEST Function

Gets the status of the specified work request.

Syntax

FUNCTION get_work_request (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dt_database_tools_get_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbtools.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_DATABASE_TOOLS_CONNECTIONS Function

Returns a list of Database Tools connections.

Syntax

FUNCTION list_database_tools_connections (
  compartment_id varchar2,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  l_type dbms_cloud_oci_database_tools_varchar2_tbl DEFAULT NULL,
  runtime_support dbms_cloud_oci_database_tools_varchar2_tbl DEFAULT NULL,
  related_resource_identifier varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dt_database_tools_list_database_tools_connections_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The ID of the compartment in which to list resources.
`lifecycle_state`	(optional) A filter to return only resources their `lifecycleState` matches the specified `lifecycleState`. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED', 'INACTIVE'
`display_name`	(optional) A filter to return only resources that match the entire specified display name.
`l_type`	(optional) A filter to return only resources their type matches the specified type. Allowed values are: 'ORACLE_DATABASE', 'MYSQL', 'POSTGRESQL', 'GENERIC_JDBC'
`runtime_support`	(optional) A filter to return only resources with one of the specified runtimeSupport values. Allowed values are: 'SUPPORTED', 'UNSUPPORTED'
`related_resource_identifier`	(optional) A filter to return only resources associated to the related resource identifier OCID passed in the query string.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: 'timeCreated', 'displayName'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbtools.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_DATABASE_TOOLS_ENDPOINT_SERVICES Function

Returns a list of Database Tools endpoint services.

Syntax

FUNCTION list_database_tools_endpoint_services (
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dt_database_tools_list_database_tools_endpoint_services_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The ID of the compartment in which to list resources.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: 'timeCreated', 'displayName'
`opc_request_id`	(optional) The client request ID for tracing.
`lifecycle_state`	(optional) A filter to return only resources their `lifecycleState` matches the specified `lifecycleState`. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED', 'INACTIVE'
`display_name`	(optional) A filter to return only resources that match the entire specified display name.
`name`	(optional) A filter to return only resources that match the entire specified name.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbtools.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_DATABASE_TOOLS_PRIVATE_ENDPOINTS Function

Returns a list of Database Tools private endpoints.

Syntax

FUNCTION list_database_tools_private_endpoints (
  compartment_id varchar2,
  subnet_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  endpoint_service_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dt_database_tools_list_database_tools_private_endpoints_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The ID of the compartment in which to list resources.
`subnet_id`	(optional) A filter to return only resources their `subnetId` matches the specified `subnetId`.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: 'timeCreated', 'displayName'
`opc_request_id`	(optional) The client request ID for tracing.
`endpoint_service_id`	(optional) A filter to return only resources their `endpointServiceId` matches the specified `endpointServiceId`.
`lifecycle_state`	(optional) A filter to return only resources their `lifecycleState` matches the specified `lifecycleState`. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED', 'INACTIVE'
`display_name`	(optional) A filter to return only resources that match the entire specified display name.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbtools.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUEST_ERRORS Function

Returns a paginated list of errors for the specified work request.

Syntax

FUNCTION list_work_request_errors (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dt_database_tools_list_work_request_errors_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`opc_request_id`	(optional) The client request ID for tracing.
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: 'timeCreated', 'displayName'
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of items to return.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbtools.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUEST_LOGS Function

Returns a paginated list of logs for the specified work request.

Syntax

FUNCTION list_work_request_logs (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dt_database_tools_list_work_request_logs_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`opc_request_id`	(optional) The client request ID for tracing.
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: 'timeCreated', 'displayName'
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of items to return.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbtools.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUESTS Function

Lists the work requests in a compartment.

Syntax

FUNCTION list_work_requests (
  compartment_id varchar2,
  resource_identifier varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dt_database_tools_list_work_requests_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The ID of the compartment in which to list resources.
`resource_identifier`	(optional) The OCID of the resource.
`opc_request_id`	(optional) The client request ID for tracing.
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. If no value is specified timeAccepted is default. Allowed values are: 'timeAccepted'
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of items to return.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbtools.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

REMOVE_DATABASE_TOOLS_CONNECTION_LOCK Function

Removes a lock from a DatabaseToolsConnection resource.

Syntax

FUNCTION remove_database_tools_connection_lock (
  database_tools_connection_id varchar2,
  remove_resource_lock_details dbms_cloud_oci_database_tools_remove_resource_lock_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dt_database_tools_remove_database_tools_connection_lock_response_t;

Parameters

Parameter	Description
`database_tools_connection_id`	(required) The OCID of a Database Tools connection.
`remove_resource_lock_details`	(required) RemoveResourceLockDetails body parameter
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbtools.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

REMOVE_DATABASE_TOOLS_PRIVATE_ENDPOINT_LOCK Function

Removes a lock from a DatabaseToolsPrivateEndpoint resource.

Syntax

FUNCTION remove_database_tools_private_endpoint_lock (
  database_tools_private_endpoint_id varchar2,
  remove_resource_lock_details dbms_cloud_oci_database_tools_remove_resource_lock_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dt_database_tools_remove_database_tools_private_endpoint_lock_response_t;

Parameters

Parameter	Description
`database_tools_private_endpoint_id`	(required) The OCID of a Database Tools private endpoint.
`remove_resource_lock_details`	(required) RemoveResourceLockDetails body parameter
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbtools.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_DATABASE_TOOLS_CONNECTION Function

Updates the specified Database Tools connection.

Syntax

FUNCTION update_database_tools_connection (
  database_tools_connection_id varchar2,
  update_database_tools_connection_details dbms_cloud_oci_database_tools_update_database_tools_connection_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  is_lock_override number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dt_database_tools_update_database_tools_connection_response_t;

Parameters

Parameter	Description
`database_tools_connection_id`	(required) The OCID of a Database Tools connection.
`update_database_tools_connection_details`	(required) The information to be updated.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`is_lock_override`	(optional) Whether to override locks (if any exist).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbtools.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_DATABASE_TOOLS_PRIVATE_ENDPOINT Function

Updates the specified Database Tools private endpoint.

Syntax

FUNCTION update_database_tools_private_endpoint (
  database_tools_private_endpoint_id varchar2,
  update_database_tools_private_endpoint_details dbms_cloud_oci_database_tools_update_database_tools_private_endpoint_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  is_lock_override number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dt_database_tools_update_database_tools_private_endpoint_response_t;

Parameters

Parameter	Description
`database_tools_private_endpoint_id`	(required) The OCID of a Database Tools private endpoint.
`update_database_tools_private_endpoint_details`	(required) The information to be updated.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`is_lock_override`	(optional) Whether to override locks (if any exist).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbtools.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

VALIDATE_DATABASE_TOOLS_CONNECTION Function

Validates the Database Tools connection details by establishing a connection to the database.

Syntax

FUNCTION validate_database_tools_connection (
  database_tools_connection_id varchar2,
  validate_database_tools_connection_details dbms_cloud_oci_database_tools_validate_database_tools_connection_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dt_database_tools_validate_database_tools_connection_response_t;

Parameters

Parameter	Description
`database_tools_connection_id`	(required) The OCID of a Database Tools connection.
`validate_database_tools_connection_details`	(required) Request to validate a DatabaseToolsConnection.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbtools.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

Oracle Cloud Infrastructure Documentation Try Free Tier

ADD_DATABASE_TOOLS_CONNECTION_LOCK Function 🔗

ADD_DATABASE_TOOLS_PRIVATE_ENDPOINT_LOCK Function 🔗

CHANGE_DATABASE_TOOLS_CONNECTION_COMPARTMENT Function 🔗

CHANGE_DATABASE_TOOLS_PRIVATE_ENDPOINT_COMPARTMENT Function 🔗

CREATE_DATABASE_TOOLS_CONNECTION Function 🔗

CREATE_DATABASE_TOOLS_PRIVATE_ENDPOINT Function 🔗

DELETE_DATABASE_TOOLS_CONNECTION Function 🔗

DELETE_DATABASE_TOOLS_PRIVATE_ENDPOINT Function 🔗

GET_DATABASE_TOOLS_CONNECTION Function 🔗

GET_DATABASE_TOOLS_ENDPOINT_SERVICE Function 🔗

GET_DATABASE_TOOLS_PRIVATE_ENDPOINT Function 🔗

GET_WORK_REQUEST Function 🔗

LIST_DATABASE_TOOLS_CONNECTIONS Function 🔗

LIST_DATABASE_TOOLS_ENDPOINT_SERVICES Function 🔗

LIST_DATABASE_TOOLS_PRIVATE_ENDPOINTS Function 🔗

LIST_WORK_REQUEST_ERRORS Function 🔗

LIST_WORK_REQUEST_LOGS Function 🔗

LIST_WORK_REQUESTS Function 🔗

REMOVE_DATABASE_TOOLS_CONNECTION_LOCK Function 🔗

REMOVE_DATABASE_TOOLS_PRIVATE_ENDPOINT_LOCK Function 🔗

UPDATE_DATABASE_TOOLS_CONNECTION Function 🔗

UPDATE_DATABASE_TOOLS_PRIVATE_ENDPOINT Function 🔗

VALIDATE_DATABASE_TOOLS_CONNECTION Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

ADD_DATABASE_TOOLS_CONNECTION_LOCK Function

ADD_DATABASE_TOOLS_PRIVATE_ENDPOINT_LOCK Function

CHANGE_DATABASE_TOOLS_CONNECTION_COMPARTMENT Function

CHANGE_DATABASE_TOOLS_PRIVATE_ENDPOINT_COMPARTMENT Function

CREATE_DATABASE_TOOLS_CONNECTION Function

CREATE_DATABASE_TOOLS_PRIVATE_ENDPOINT Function

DELETE_DATABASE_TOOLS_CONNECTION Function

DELETE_DATABASE_TOOLS_PRIVATE_ENDPOINT Function

GET_DATABASE_TOOLS_CONNECTION Function

GET_DATABASE_TOOLS_ENDPOINT_SERVICE Function

GET_DATABASE_TOOLS_PRIVATE_ENDPOINT Function

GET_WORK_REQUEST Function

LIST_DATABASE_TOOLS_CONNECTIONS Function

LIST_DATABASE_TOOLS_ENDPOINT_SERVICES Function

LIST_DATABASE_TOOLS_PRIVATE_ENDPOINTS Function

LIST_WORK_REQUEST_ERRORS Function

LIST_WORK_REQUEST_LOGS Function

LIST_WORK_REQUESTS Function

REMOVE_DATABASE_TOOLS_CONNECTION_LOCK Function

REMOVE_DATABASE_TOOLS_PRIVATE_ENDPOINT_LOCK Function

UPDATE_DATABASE_TOOLS_CONNECTION Function

UPDATE_DATABASE_TOOLS_PRIVATE_ENDPOINT Function

VALIDATE_DATABASE_TOOLS_CONNECTION Function