Oracle Cloud Infrastructure Documentation
Try Free Tier

Tenant Manager Control Plane Orders Functions

Package: DBMS_CLOUD_OCI_TMCP_ORDERS

ACTIVATE_ORDER Function

Triggers an order activation workflow on behalf of the tenant, given by compartment ID in the body.

Syntax

FUNCTION activate_order (
  activate_order_details dbms_cloud_oci_tenant_manager_control_plane_activate_order_details_t,
  activation_token varchar2,
  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_orders_activate_order_response_t;

Parameters

Parameter Description

activate_order_details

(required) The information needed to activate an order in a tenancy.

activation_token

(required) Activation token containing an order ID. A JWT RFC 7519-formatted string.

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.

GET_ORDER Function

Returns the order details given by the order ID in the JWT.

Syntax

FUNCTION get_order (
  activation_token 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_orders_get_order_response_t;

Parameters

Parameter Description

activation_token

(required) Activation token containing an order ID. A JWT RFC 7519-formatted string.

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?