Oracle Cloud Infrastructure Documentation
Try Free Tier

Tenant Manager Control Plane Domain Functions

Package: DBMS_CLOUD_OCI_TMCP_DOMAIN

CREATE_DOMAIN Function

Begins the registration process for claiming a domain.

Syntax

FUNCTION create_domain (
  create_domain_details dbms_cloud_oci_tenant_manager_control_plane_create_domain_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_tmcp_domain_create_domain_response_t;

Parameters

Parameter Description

create_domain_details

(required) Parameters for domain creation.

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 will be rejected.

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://organizations.{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_DOMAIN Function

Releases the domain, making it available to be claimed again by another tenancy.

Syntax

FUNCTION delete_domain (
  domain_id varchar2,
  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_tmcp_domain_delete_domain_response_t;

Parameters

Parameter Description

domain_id

(required) The domain OCID.

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://organizations.{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_DOMAIN Function

Gets information about the domain.

Syntax

FUNCTION get_domain (
  domain_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_tmcp_domain_get_domain_response_t;

Parameters

Parameter Description

domain_id

(required) The domain OCID.

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://organizations.{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_DOMAINS Function

Return a (paginated) list of domains.

Syntax

FUNCTION list_domains (
  compartment_id varchar2,
  domain_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  status varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_tmcp_domain_list_domains_response_t;

Parameters

Parameter Description

compartment_id

(required) The ID of the compartment in which to list resources.

domain_id

(optional) The domain OCID.

lifecycle_state

(optional) The lifecycle state of the resource.

Allowed values are: 'CREATING', 'ACTIVE', 'INACTIVE', 'UPDATING', 'FAILED', 'TERMINATED'

status

(optional) The status of the domain.

name

(optional) A filter to return only resources that exactly match the name given.

opc_request_id

(optional) The client request ID for tracing.

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.

sort_by

(optional) The field to sort by. Only one sort order can be provided. * The default order for timeCreated is descending. * The default order for displayName is ascending. * If no value is specified, timeCreated is the default.

Allowed values are: 'timeCreated', 'displayName'

sort_order

(optional) The sort order to use, whether 'asc' or 'desc'.

Allowed values are: 'ASC', 'DESC'

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://organizations.{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_DOMAIN Function

Updates the domain.

Syntax

FUNCTION update_domain (
  domain_id varchar2,
  update_domain_details dbms_cloud_oci_tenant_manager_control_plane_update_domain_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_tmcp_domain_update_domain_response_t;

Parameters

Parameter Description

domain_id

(required) The domain OCID.

update_domain_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.

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://organizations.{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.

Was this article helpful?