WAA Work Request Functions
Package: DBMS_CLOUD_OCI_WAA_WORK_REQUEST
GET_WORK_REQUEST Function
Gets the status of the WorkRequest with the given OCID.
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_waa_work_request_get_work_request_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The OCID of the asynchronous request. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://waa.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(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 WorkRequest.
Syntax
FUNCTION list_work_request_errors (
work_request_id varchar2,
opc_request_id 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_waa_work_request_list_work_request_errors_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The OCID of the asynchronous request. |
|
(optional) The client request ID for tracing. |
|
(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. |
|
(optional) The maximum number of items to return. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://waa.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(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 WorkRequest.
Syntax
FUNCTION list_work_request_logs (
work_request_id varchar2,
opc_request_id 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_waa_work_request_list_work_request_logs_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The OCID of the asynchronous request. |
|
(optional) The client request ID for tracing. |
|
(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. |
|
(optional) The maximum number of items to return. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://waa.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_WORK_REQUESTS Function
Lists the WorkRequests in a compartment.
Syntax
FUNCTION list_work_requests (
compartment_id varchar2,
work_request_id varchar2 DEFAULT NULL,
opc_request_id 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_waa_work_request_list_work_requests_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The OCID of the compartment in which to list resources. |
|
(optional) The OCID of the asynchronous work request. |
|
(optional) The client request ID for tracing. |
|
(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. |
|
(optional) The maximum number of items to return. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://waa.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |