OPA Functions

CANCEL_WORK_REQUEST Function

Cancel work request with the given ID.

Syntax

FUNCTION cancel_work_request (
  work_request_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_opa_opa_instance_cancel_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`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://process.{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_OPA_INSTANCE_COMPARTMENT Function

Moves a OpaInstance resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Syntax

FUNCTION change_opa_instance_compartment (
  opa_instance_id varchar2,
  change_opa_instance_compartment_details dbms_cloud_oci_opa_change_opa_instance_compartment_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_opa_opa_instance_change_opa_instance_compartment_response_t;

Parameters

Parameter	Description
`opa_instance_id`	(required) unique OpaInstance identifier
`change_opa_instance_compartment_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://process.{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_OPA_INSTANCE Function

Creates a new OpaInstance.

Syntax

FUNCTION create_opa_instance (
  create_opa_instance_details dbms_cloud_oci_opa_create_opa_instance_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_opa_opa_instance_create_opa_instance_response_t;

Parameters

Parameter	Description
`create_opa_instance_details`	(required) Details for the new OpaInstance.
`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.
`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://process.{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_OPA_INSTANCE Function

Deletes a OpaInstance resource by identifier

Syntax

FUNCTION delete_opa_instance (
  opa_instance_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_opa_opa_instance_delete_opa_instance_response_t;

Parameters

Parameter	Description
`opa_instance_id`	(required) unique OpaInstance identifier
`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://process.{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_OPA_INSTANCE Function

Gets a OpaInstance by identifier

Syntax

FUNCTION get_opa_instance (
  opa_instance_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_opa_opa_instance_get_opa_instance_response_t;

Parameters

Parameter	Description
`opa_instance_id`	(required) unique OpaInstance identifier
`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://process.{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 work request with the given ID.

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_opa_opa_instance_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://process.{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_OPA_INSTANCES Function

Returns a list of OpaInstances.

Syntax

FUNCTION list_opa_instances (
  compartment_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  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,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opa_opa_instance_list_opa_instances_response_t;

Parameters

Parameter	Description
`compartment_id`	(optional) The ID of the compartment in which to list resources.
`lifecycle_state`	(optional) A filter to return only resources their lifecycleState matches the given lifecycleState.
`display_name`	(optional) A filter to return only resources that match the entire display name given.
`id`	(optional) unique OpaInstance identifier
`limit`	(optional) The maximum number of items to return.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
`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. 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://process.{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

Return a (paginated) list of errors for a given work request.

Syntax

FUNCTION list_work_request_errors (
  work_request_id varchar2,
  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_opa_opa_instance_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.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
`limit`	(optional) The maximum number of items to return.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. Allowed values are: 'timeAccepted'
`sort_order`	(optional) The sort order to use, either '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://process.{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

Return a (paginated) list of logs for a given work request.

Syntax

FUNCTION list_work_request_logs (
  work_request_id varchar2,
  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_opa_opa_instance_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.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
`limit`	(optional) The maximum number of items to return.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. Allowed values are: 'timeAccepted'
`sort_order`	(optional) The sort order to use, either '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://process.{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 DEFAULT NULL,
  work_request_id varchar2 DEFAULT NULL,
  status varchar2 DEFAULT NULL,
  resource_id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opa_opa_instance_list_work_requests_response_t;

Parameters

Parameter	Description
`compartment_id`	(optional) The ID of the compartment in which to list resources.
`work_request_id`	(optional) The ID of the asynchronous work request.
`status`	(optional) A filter to return only resources their lifecycleState matches the given OperationStatus. Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'WAITING', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED'
`resource_id`	(optional) The ID of the resource affected by the work request.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
`limit`	(optional) The maximum number of items to return.
`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. Allowed values are: 'timeAccepted'
`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://process.{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_OPA_INSTANCE Function

Updates the OpaInstance

Syntax

FUNCTION update_opa_instance (
  opa_instance_id varchar2,
  update_opa_instance_details dbms_cloud_oci_opa_update_opa_instance_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_opa_opa_instance_update_opa_instance_response_t;

Parameters

Parameter	Description
`opa_instance_id`	(required) unique OpaInstance identifier
`update_opa_instance_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://process.{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

CANCEL_WORK_REQUEST Function 🔗

CHANGE_OPA_INSTANCE_COMPARTMENT Function 🔗

CREATE_OPA_INSTANCE Function 🔗

DELETE_OPA_INSTANCE Function 🔗

GET_OPA_INSTANCE Function 🔗

GET_WORK_REQUEST Function 🔗

LIST_OPA_INSTANCES Function 🔗

LIST_WORK_REQUEST_ERRORS Function 🔗

LIST_WORK_REQUEST_LOGS Function 🔗

LIST_WORK_REQUESTS Function 🔗

UPDATE_OPA_INSTANCE Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

CANCEL_WORK_REQUEST Function

CHANGE_OPA_INSTANCE_COMPARTMENT Function

CREATE_OPA_INSTANCE Function

DELETE_OPA_INSTANCE Function

GET_OPA_INSTANCE Function

GET_WORK_REQUEST Function

LIST_OPA_INSTANCES Function

LIST_WORK_REQUEST_ERRORS Function

LIST_WORK_REQUEST_LOGS Function

LIST_WORK_REQUESTS Function

UPDATE_OPA_INSTANCE Function