Use ListRemediations to Retrieve Config Remediation Templates - Cloud Config - Alibaba Cloud - Cloud Config

Queries remediation template execution details.

Operation description

The following example queries remediation templates for rule cr-6b7c626622af00b4****.

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:ListRemediations

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ConfigRuleIds	string	No	The rule IDs. Separate multiple rule IDs with commas (,). To obtain a rule ID, call ListConfigRules.	cr-6b7c626622af00b4****
PageNumber	integer	No	The page number. Pages start from page 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 50.	10

Shared request fields are listed in Common parameters.

Response elements

Element	Type	Description	Example
	object	None
RequestId	string	The request ID.	0146963A-20C0-4E75-B93A-7D622B5FD7C8
Remediations	array<object>	The converted remediation template configuration. Returned only for OOS remediation templates.
	object	N/A.
LastSuccessfulInvocationType	string	The last successful execution mode. Valid values: NON_EXECUTION: The remediation template was not executed. AUTO_EXECUTION: The remediation template was automatically executed. MANUAL_EXECUTION: The remediation template was manually executed. NOT_CONFIG: The execution mode was not specified.	AUTO_EXECUTION
RemediationTemplateId	string	The ID of the remediation template.	ACS-OSS-PutBucketAcl
RemediationId	string	The ID of the remediation template.	crr-6b7c626622af0026****
RemediationSourceType	string	The remediation source. Valid values: ALIYUN: official template. CUSTOM: custom template. NONE: none.	ALIYUN
RemediationType	string	The remediation template type. Valid values: OOS: Operation Orchestration Service (official remediation) FC: Function Compute (custom remediation)	OOS
LastSuccessfulInvocationId	string	The last successful execution ID.	bd7629fb-cac8-42fe-bcb1-e362c5a6****
AccountId	integer	The Alibaba Cloud account ID of the resource owner.	100931896542****
InvokeType	string	The execution mode. Valid values: NON_EXECUTION: The remediation template was not executed. AUTO_EXECUTION: The remediation template was automatically executed. MANUAL_EXECUTION: The remediation template was manually executed. NOT_CONFIG: The execution mode was not specified.	AUTO_EXECUTION
ConfigRuleId	string	The rule ID.	cr-6b7c626622af00b4****
LastSuccessfulInvocationTime	integer	The timestamp of the last successful execution. Unit: milliseconds.	1625451393589
RemediationOriginParams	string	The converted remediation template configuration. Available only for OOS remediation templates.	{"bucketName": "{resourceId}", "regionId": "{regionId}", "permissionName": "private"}
PageNumber	integer	The page number. Pages start from page 1.	1
PageSize	integer	The number of entries per page. Valid values: 1 to 50.	10
TotalCount	string	The total number of remediation settings.	1

Examples

Success response

JSON format

{
  "RequestId": "0146963A-20C0-4E75-B93A-7D622B5FD7C8",
  "Remediations": [
    {
      "LastSuccessfulInvocationType": "AUTO_EXECUTION",
      "RemediationTemplateId": "ACS-OSS-PutBucketAcl",
      "RemediationId": "crr-6b7c626622af0026****",
      "RemediationSourceType": "ALIYUN",
      "RemediationType": "OOS",
      "LastSuccessfulInvocationId": "bd7629fb-cac8-42fe-bcb1-e362c5a6****",
      "AccountId": 0,
      "InvokeType": "AUTO_EXECUTION",
      "ConfigRuleId": "cr-6b7c626622af00b4****",
      "LastSuccessfulInvocationTime": 1625451393589,
      "RemediationOriginParams": "{\"bucketName\": \"{resourceId}\", \"regionId\": \"{regionId}\", \"permissionName\": \"private\"}"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": "1"
}

Error codes

HTTP status code	Error code	Error message	Description
404	AccountNotExisted	Your account does not exist.
503	ServiceUnavailable	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.