Oracle Cloud Infrastructure Documentation
Try Free Tier

Tenant Manager Control Plane Link Functions

Package: DBMS_CLOUD_OCI_TMCP_LINK

DELETE_LINK Function

Starts the link termination workflow.

Syntax

FUNCTION delete_link (
  link_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_link_delete_link_response_t;

Parameters

Parameter Description

link_id

(required) OCID of the link to terminate.

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_LINK Function

Gets information about the link.

Syntax

FUNCTION get_link (
  link_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_link_get_link_response_t;

Parameters

Parameter Description

link_id

(required) OCID of the link to retrieve.

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_LINKS Function

Return a (paginated) list of links.

Syntax

FUNCTION list_links (
  parent_tenancy_id varchar2 DEFAULT NULL,
  child_tenancy_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number 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_link_list_links_response_t;

Parameters

Parameter Description

parent_tenancy_id

(optional) The ID of the parent tenancy this link is associated with.

child_tenancy_id

(optional) The ID of the child tenancy this link is associated with.

lifecycle_state

(optional) The lifecycle state of the resource.

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

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

Was this article helpful?