work_requests

Creates, updates, deletes, gets or lists a work_requests resource.

Overview

Name	work_requests
Type	Resource
Id	oci.load_balancer.work_requests

Fields

The following fields are returned by SELECT queries:

get

The work request is being retrieved.

Name	Datatype	Description
id	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the work request.
compartmentId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the load balancer.
errorDetails	array
lifecycleState	string	The current state of the work request. (ACCEPTED, IN_PROGRESS, FAILED, SUCCEEDED)
loadBalancerId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer with which the work request is associated.
message	string	A collection of data, related to the load balancer provisioning process, that helps with debugging in the event of failure. Possible data elements include: - workflow name - event ID - work request ID - load balancer ID - workflow completion message
timeAccepted	string (date-time)	The date and time the work request was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
timeFinished	string (date-time)	The date and time the work request was completed, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
type	string	The type of action the work request represents. Example: CreateListener

list

Many of the API requests you use to create and configure load balancing do not take effect immediately.<br />In these cases, the request spawns an asynchronous work flow to fulfill the request. WorkRequest objects provide visibility<br />for in-progress work flows.<br />For more information about work requests, see [Viewing the State of a Work Request](/Content/Balance/Tasks/viewingworkrequest.htm).<br />

Name	Datatype	Description
id	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the work request.
compartmentId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the load balancer.
errorDetails	array
lifecycleState	string	The current state of the work request. (ACCEPTED, IN_PROGRESS, FAILED, SUCCEEDED)
loadBalancerId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer with which the work request is associated.
message	string	A collection of data, related to the load balancer provisioning process, that helps with debugging in the event of failure. Possible data elements include: - workflow name - event ID - work request ID - load balancer ID - workflow completion message
timeAccepted	string (date-time)	The date and time the work request was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
timeFinished	string (date-time)	The date and time the work request was completed, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
type	string	The type of action the work request represents. Example: CreateListener

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	workRequestId, region	opc-request-id	Gets the details of a work request.
list	select	loadBalancerId, region	opc-request-id, limit, page	Lists the work requests for a given load balancer.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
loadBalancerId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the work requests to retrieve.
region	string	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
workRequestId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the work request to retrieve.
limit	integer (int64)	For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). Example: 50
opc-request-id	string	The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
page	string	For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). Example: 3

SELECT examples

get

Gets the details of a work request.

SELECT
id,
compartmentId,
errorDetails,
lifecycleState,
loadBalancerId,
message,
timeAccepted,
timeFinished,
type
FROM oci.load_balancer.work_requests
WHERE workRequestId = '{{ workRequestId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

list

Lists the work requests for a given load balancer.

SELECT
id,
compartmentId,
errorDetails,
lifecycleState,
loadBalancerId,
message,
timeAccepted,
timeFinished,
type
FROM oci.load_balancer.work_requests
WHERE loadBalancerId = '{{ loadBalancerId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
;