Track Remediation Executions with ListRemediationExecutions - Cloud Config - Alibaba Cloud - Cloud Config

Queries the remediation execution records of a specified rule.

Operation description

This topic provides an example on how to query the remediation execution records of the rule cr-5392626622af0000****.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

config:ListRemediationExecutions

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ConfigRuleId	string	Yes	The rule ID. Before calling this operation, you must call CreateRemediation to configure a remediation policy for the rule. Otherwise, the server returns Invalid.ConfigRuleId.Value (400). The recommended calling sequence is ListConfigRules, CreateRemediation, and ListRemediationExecutions.	cr-5392626622af0000****
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. If the response is truncated, you can use this token to initiate another request and obtain the remaining records.	aVCjqNaSy0Ps7zSMGu25****
MaxResults	integer	No	The maximum number of entries to return in a single request. Valid values: 10 to 100.	10
ExecutionStatus	string	No	The remediation execution status. Valid values: Success Failed	Success

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	13E67493-3165-529A-A961-BE9E4B11BA11
RemediationExecutionData	object	The remediation execution data.
RemediationExecutions	array<object>	The remediation execution records.
	object
ExecutionInvocationId	string	The invocation ID of the remediation execution record.	exec-befded3781994ccf****
ExecutionStatus	string	The status of the remediation execution record. Valid values: Success: The remediation was successful. Failed: The remediation failed.	Success
ExecutionResourceType	string	The type of the remediated resource.	ACS::RDS::DBInstance
ExecutionCreateDate	string	The time when the remediation execution record was created. The time is in UTC and follows the ISO 8601 standard. The time ends with Z. Example: 2023-06-25T11:48:15Z.	2023-06-25T11:48:15Z
ExecutionStatusMessage	string	The error message returned when the remediation execution failed.	Invocation time out.
ExecutionResourceIds	string	The IDs of the remediated resources. Multiple resource IDs are separated by commas (,).	rm-0jlk629z240l8****
NextToken	string	The pagination token that is used in the next request to retrieve a new page of results. If the response is truncated, you can use this token to initiate another request and obtain the remaining records.	cMbjqNaYs0Ps7zSNiu37****
MaxResults	integer	The maximum number of entries returned in a single request.	10

Examples

Success response

JSON format

{
  "RequestId": "13E67493-3165-529A-A961-BE9E4B11BA11",
  "RemediationExecutionData": {
    "RemediationExecutions": [
      {
        "ExecutionInvocationId": "exec-befded3781994ccf****",
        "ExecutionStatus": "Success",
        "ExecutionResourceType": "ACS::RDS::DBInstance",
        "ExecutionCreateDate": "2023-06-25T11:48:15Z",
        "ExecutionStatusMessage": "Invocation time out.",
        "ExecutionResourceIds": "rm-0jlk629z240l8****"
      }
    ],
    "NextToken": "cMbjqNaYs0Ps7zSNiu37****",
    "MaxResults": 10
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	NoPermission	You are not authorized to perform this operation.	You are not authorized to perform this operation.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.	The request has failed due to a temporary failure of the server.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.