All Products
Search
Document Center

Cloud Config:ListRemediationExecutions

Last Updated:Jun 17, 2024

Queries the remediation records of a rule.

Operation description

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
config:ListRemediationExecutionsList
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ConfigRuleIdstringYes

The rule ID.

cr-5392626622af0000****
NextTokenstringNo

The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.

aVCjqNaSy0Ps7zSMGu25****
MaxResultslongNo

The maximum number of entries to return for a single request. Valid values: 10 to 100.

10
ExecutionStatusstringNo

The status of the remediation. Valid values:

  • Success
  • Failed
Success

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

13E67493-3165-529A-A961-BE9E4B11BA11
RemediationExecutionDataobject

The queried remediation records.

RemediationExecutionsobject []

The queried remediation records.

ExecutionInvocationIdstring

The invocation ID of the remediation record.

exec-befded3781994ccf****
ExecutionStatusstring

The status of the remediation record. Valid values:

  • Success
  • Failed
Success
ExecutionResourceTypestring

The resource type.

ACS::RDS::DBInstance
ExecutionCreateDatestring

The time when the remediation record was created.

2023-06-25T11:48:15Z
ExecutionStatusMessagestring

The error message returned when the remediation fails.

Invocation time out.
ExecutionResourceIdsstring

The IDs of the resources to which the remediation belongs. Separate multiple resource IDs with commas (,).

rm-0jlk629z240l8****
NextTokenstring

A pagination token. It can be used in the next request to retrieve a new page of results.

cMbjqNaYs0Ps7zSNiu37****
MaxResultslong

The maximum number of entries to return for a single request.

10

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400NoPermissionYou are not authorized to perform this operation.You are not authorized to perform this operation.
503ServiceUnavailableThe request has failed due to a temporary failure of the server.The request has failed due to a temporary failure of the server.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history