scheduled_runs
Creates, updates, deletes, gets or lists a scheduled_runs resource.
Overview​
| Name | scheduled_runs |
| Type | Resource |
| Id | oci.usage.scheduled_runs |
Fields​
The following fields are returned by SELECT queries:
- get
- list
The saved scheduled run.
| Name | Datatype | Description |
|---|---|---|
id | string | The OCID representing a unique shedule run. |
lifecycleDetails | string | Additional details about the scheduled run. |
lifecycleState | string | Specifies whether or not the schedule job was successfully run. (FAILED, SUCCEEDED) |
scheduleId | string | The OCID representing a unique shedule. |
timeCreated | string (date-time) | The time the schedule started executing. |
timeFinished | string (date-time) | The time the schedule finished executing. |
Returns the schedule past runs list.
| Name | Datatype | Description |
|---|---|---|
id | string | The OCID representing a unique shedule run. |
lifecycleDetails | string | Additional details about the scheduled run. |
lifecycleState | string | Specifies whether or not the schedule job was successfully run. (x-obmcs-enumref: #/definitions/ScheduledRun/lifecycleState) |
scheduleId | string | The OCID representing a unique shedule. |
timeCreated | string (date-time) | The time the schedule started executing. |
timeFinished | string (date-time) | The time the schedule finished executing. |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | scheduledRunId, region | opc-request-id | Returns the saved schedule run.<br /> |
list | select | scheduleId, region | opc-request-id, page, limit, sortBy, sortOrder | Returns the schedule history list.<br /> |
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 |
|---|---|---|
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) |
scheduleId | string | The schedule unique ID. |
scheduledRunId | string | The scheduled run unique OCID. |
limit | integer | The maximum number of items to return. |
opc-request-id | string | Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
page | string | The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. |
sortBy | string | The field to sort by. If not specified, the default is timeCreated. |
sortOrder | string | The sort order to use, whether 'asc' or 'desc'. |
SELECT examples​
- get
- list
Returns the saved schedule run.<br />
SELECT
id,
lifecycleDetails,
lifecycleState,
scheduleId,
timeCreated,
timeFinished
FROM oci.usage.scheduled_runs
WHERE scheduledRunId = '{{ scheduledRunId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;
Returns the schedule history list.<br />
SELECT
id,
lifecycleDetails,
lifecycleState,
scheduleId,
timeCreated,
timeFinished
FROM oci.usage.scheduled_runs
WHERE scheduleId = '{{ scheduleId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
AND page = '{{ page }}'
AND limit = '{{ limit }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
;