execution_actions

Creates, updates, deletes, gets or lists an execution_actions resource.

Overview

Name	`execution_actions`
Type	Resource
Id	`oci.database.execution_actions`

Fields

The following fields are returned by SELECT queries:

get
list

The execution action details.

Name	Datatype	Description
`id`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the execution action.
`actionMembers`	`array`	List of action members of this execution action.
`actionParams`	`object`	Map<ParamName, ParamValue> where a key value pair describes the specific action parameter. Example: `{"count": "3"}`
`actionType`	`string`	The action type of the execution action being performed (DB_SERVER_FULL_SOFTWARE_UPDATE, STORAGE_SERVER_FULL_SOFTWARE_UPDATE, NETWORK_SWITCH_FULL_SOFTWARE_UPDATE, DB_SERVER_ONLINE_SOFTWARE_UPDATE)
`compartmentId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
`definedTags`	`object`	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
`description`	`string`	Description of the execution action.
`displayName`	`string`	The user-friendly name for the execution action. The name does not need to be unique.
`estimatedTimeInMins`	`integer`	The estimated time of the execution action in minutes.
`executionActionOrder`	`integer`	The priority order of the execution action.
`executionWindowId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the execution window resource the execution action belongs to.
`freeformTags`	`object`	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
`lifecycleDetails`	`string`	Additional information about the current lifecycle state.
`lifecycleState`	`string`	The current state of the execution action. Valid states are SCHEDULED, IN_PROGRESS, FAILED, CANCELED, UPDATING, DELETED, SUCCEEDED and PARTIAL_SUCCESS. (SCHEDULED, IN_PROGRESS, FAILED, CANCELED, UPDATING, DELETED, SUCCEEDED, PARTIAL_SUCCESS)
`lifecycleSubstate`	`string`	The current sub-state of the execution action. Valid states are DURATION_EXCEEDED, MAINTENANCE_IN_PROGRESS and WAITING. (DURATION_EXCEEDED, MAINTENANCE_IN_PROGRESS, WAITING)
`systemTags`	`object`	System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
`timeCreated`	`string (date-time)`	The date and time the execution action was created.
`timeUpdated`	`string (date-time)`	The last date and time that the execution action was updated.

Details of an execution action.

Name	Datatype	Description
`id`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the execution action.
`actionMembers`	`array`	List of action members of this execution action.
`actionParams`	`object`	Map<ParamName, ParamValue> where a key value pair describes the specific action parameter. Example: `{"count": "3"}`
`actionType`	`string`	The action type of the execution action being performed (DB_SERVER_FULL_SOFTWARE_UPDATE, STORAGE_SERVER_FULL_SOFTWARE_UPDATE, NETWORK_SWITCH_FULL_SOFTWARE_UPDATE, DB_SERVER_ONLINE_SOFTWARE_UPDATE)
`compartmentId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
`definedTags`	`object`	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
`description`	`string`	Description of the execution action.
`displayName`	`string`	The user-friendly name for the execution action. The name does not need to be unique.
`estimatedTimeInMins`	`integer`	The estimated time of the execution action in minutes.
`executionActionOrder`	`integer`	The priority order of the execution action.
`executionWindowId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the execution window resource the execution action belongs to.
`freeformTags`	`object`	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
`lifecycleDetails`	`string`	Additional information about the current lifecycle state.
`lifecycleState`	`string`	The current state of the execution action. Valid states are SCHEDULED, IN_PROGRESS, FAILED, CANCELED, UPDATING, DELETED, SUCCEEDED and PARTIAL_SUCCESS. (SCHEDULED, IN_PROGRESS, FAILED, CANCELED, UPDATING, DELETED, SUCCEEDED, PARTIAL_SUCCESS)
`lifecycleSubstate`	`string`	The current sub-state of the execution action. Valid states are DURATION_EXCEEDED, MAINTENANCE_IN_PROGRESS and WAITING. (DURATION_EXCEEDED, MAINTENANCE_IN_PROGRESS, WAITING)
`systemTags`	`object`	System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
`timeCreated`	`string (date-time)`	The date and time the execution action was created.
`timeUpdated`	`string (date-time)`	The last date and time that the execution action was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`executionActionId`, `region`	`opc-request-id`	Gets information about the specified execution action.<br />
`list`	`select`	`compartmentId`, `region`	`limit`, `page`, `opc-request-id`, `sortBy`, `sortOrder`, `lifecycleState`, `executionWindowId`, `displayName`	Lists the execution action resources in the specified compartment.<br />
`create`	`insert`	`region`, `executionWindowId`, `actionType`	`opc-retry-token`, `opc-request-id`	Creates an execution action resource.<br />
`update`	`update`	`executionActionId`, `region`	`if-match`, `opc-request-id`	Updates the execution action resource.<br />
`delete`	`delete`	`executionActionId`, `region`	`if-match`, `opc-request-id`	Deletes the execution action.<br />
`move_execution_action_member`	`exec`	`executionActionId`, `region`	`if-match`, `opc-request-id`, `opc-retry-token`	Moves an execution action member to this execution action resource from another.<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
`compartmentId`	`string`	The compartment [OCID](/Content/General/Concepts/identifiers.htm).
`executionActionId`	`string`	The execution action [OCID](/Content/General/Concepts/identifiers.htm).
`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)
`displayName`	`string`	A filter to return only resources that match the entire display name given. The match is not case sensitive.
`executionWindowId`	`string`	A filter to return only resources that match the given execution wondow id.
`if-match`	`string`	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.
`lifecycleState`	`string`	A filter to return only resources that match the given lifecycle state exactly.
`limit`	`integer`	The maximum number of items to return per page.
`opc-request-id`	`string`	Unique identifier for the request.
`opc-retry-token`	`string`	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 may be rejected).
`page`	`string`	The pagination token to continue listing from.
`sortBy`	`string`	The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.
`sortOrder`	`string`	The sort order to use, either ascending (`ASC`) or descending (`DESC`).

`SELECT` examples

get
list

Gets information about the specified execution action.

SELECT
id,
actionMembers,
actionParams,
actionType,
compartmentId,
definedTags,
description,
displayName,
estimatedTimeInMins,
executionActionOrder,
executionWindowId,
freeformTags,
lifecycleDetails,
lifecycleState,
lifecycleSubstate,
systemTags,
timeCreated,
timeUpdated
FROM oci.database.execution_actions
WHERE executionActionId = '{{ executionActionId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

Lists the execution action resources in the specified compartment.

SELECT
id,
actionMembers,
actionParams,
actionType,
compartmentId,
definedTags,
description,
displayName,
estimatedTimeInMins,
executionActionOrder,
executionWindowId,
freeformTags,
lifecycleDetails,
lifecycleState,
lifecycleSubstate,
systemTags,
timeCreated,
timeUpdated
FROM oci.database.execution_actions
WHERE compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND opc-request-id = '{{ opc-request-id }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
AND lifecycleState = '{{ lifecycleState }}'
AND executionWindowId = '{{ executionWindowId }}'
AND displayName = '{{ displayName }}'
;

`INSERT` examples

create
Manifest

Creates an execution action resource.

INSERT INTO oci.database.execution_actions (
actionMembers,
actionParams,
actionType,
compartmentId,
definedTags,
executionWindowId,
freeformTags,
region,
opc-retry-token,
opc-request-id
)
SELECT 
'{{ actionMembers }}',
'{{ actionParams }}',
'{{ actionType }}' /* required */,
'{{ compartmentId }}',
'{{ definedTags }}',
'{{ executionWindowId }}' /* required */,
'{{ freeformTags }}',
'{{ region }}',
'{{ opc-retry-token }}',
'{{ opc-request-id }}'
RETURNING
id,
actionMembers,
actionParams,
actionType,
compartmentId,
definedTags,
description,
displayName,
estimatedTimeInMins,
executionActionOrder,
executionWindowId,
freeformTags,
lifecycleDetails,
lifecycleState,
lifecycleSubstate,
systemTags,
timeCreated,
timeUpdated
;

# Description fields are for documentation purposes
- name: execution_actions
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the execution_actions resource.
  - name: actionMembers
    description: |
      List of action members of this execution action.
    value:
      - estimatedTimeInMins: {{ estimatedTimeInMins }}
        memberId: "{{ memberId }}"
        memberOrder: {{ memberOrder }}
        status: "{{ status }}"
  - name: actionParams
    value: "{{ actionParams }}"
    description: |
      Map<ParamName, ParamValue> where a key value pair describes the specific action parameter.
      Example: `{"count": "3"}`
  - name: actionType
    value: "{{ actionType }}"
    description: |
      The action type of the execution action being performed
    valid_values: ['DB_SERVER_FULL_SOFTWARE_UPDATE', 'STORAGE_SERVER_FULL_SOFTWARE_UPDATE', 'NETWORK_SWITCH_FULL_SOFTWARE_UPDATE', 'DB_SERVER_ONLINE_SOFTWARE_UPDATE']
  - name: compartmentId
    value: "{{ compartmentId }}"
    description: |
      The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
  - name: definedTags
    value: "{{ definedTags }}"
    description: |
      Defined tags for this resource. Each key is predefined and scoped to a namespace.
      For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
  - name: executionWindowId
    value: "{{ executionWindowId }}"
    description: |
      The [OCID](/Content/General/Concepts/identifiers.htm) of the execution window resource the execution action belongs to.
  - name: freeformTags
    value: "{{ freeformTags }}"
    description: |
      Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
      For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
      Example: `{"Department": "Finance"}`
  - name: opc-retry-token
    value: "{{ opc-retry-token }}"
    description: 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 may be rejected). 
    description: 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 may be rejected). 
  - name: opc-request-id
    value: "{{ opc-request-id }}"
    description: Unique identifier for the request. 
    description: Unique identifier for the request. 

`UPDATE` examples

update

Updates the execution action resource.

UPDATE oci.database.execution_actions
SET 
actionMembers = '{{ actionMembers }}',
actionParams = '{{ actionParams }}',
definedTags = '{{ definedTags }}',
executionWindowId = '{{ executionWindowId }}',
freeformTags = '{{ freeformTags }}'
WHERE 
executionActionId = '{{ executionActionId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
AND opc-request-id = '{{ opc-request-id}}'
RETURNING
id,
actionMembers,
actionParams,
actionType,
compartmentId,
definedTags,
description,
displayName,
estimatedTimeInMins,
executionActionOrder,
executionWindowId,
freeformTags,
lifecycleDetails,
lifecycleState,
lifecycleSubstate,
systemTags,
timeCreated,
timeUpdated;

`DELETE` examples

delete

Deletes the execution action.

DELETE FROM oci.database.execution_actions
WHERE executionActionId = '{{ executionActionId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match }}'
AND opc-request-id = '{{ opc-request-id }}'
;

Lifecycle Methods

move_execution_action_member

Moves an execution action member to this execution action resource from another.

EXEC oci.database.execution_actions.move_execution_action_member 
@executionActionId='{{ executionActionId }}' --required, 
@region='{{ region }}' --required, 
@if-match='{{ if-match }}', 
@opc-request-id='{{ opc-request-id }}', 
@opc-retry-token='{{ opc-retry-token }}' 
@@json=
'{
"definedTags": "{{ definedTags }}", 
"executionActionMemberCount": {{ executionActionMemberCount }}, 
"executionActionMemberId": "{{ executionActionMemberId }}", 
"freeformTags": "{{ freeformTags }}", 
"sourceExecutionActionId": "{{ sourceExecutionActionId }}"
}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​

Lifecycle Methods​