ListAggregateRemediations - Cloud Config - Alibaba Cloud Documentation Center

Queries the remediations in a specified account group.

Operation description

This topic provides an example of how to query the remediation settings for the rule cr-6b7c626622af00b4**** in the account group ca-6b4a626622af0012****.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ConfigRuleIds	string	No	The rule IDs. Separate multiple rule IDs with commas (,). For more information about how to obtain a rule ID, see ListAggregateConfigRules.	cr-6b7c626622af00b4****
AggregatorId	string	Yes	The ID of the account group. For more information about how to obtain the ID of an account group, see ListAggregators.	ca-6b4a626622af0012****

For more information about common request parameters, see Common parameters.

Response elements

Element	Type	Description	Example
	object	None.
RequestId	string	The request ID.	0146963A-20C0-4E75-B93A-7D622B5FD7C8
Remediations	array<object>	The remediation settings.
	object	None.
RemediationTemplateId	string	The ID of the remediation template.	ACS-OSS-PutBucketAcl
RemediationSourceType	string	The source of the remediation template. Valid values: ALIYUN: official template. CUSTOM: custom template. NONE: none.	ALIYUN
RemediationType	string	The type of the remediation. Valid values: OOS: Operation Orchestration Service (official remediation). FC: Function Compute (custom remediation).	OOS
LastSuccessfulInvocationId	string	The ID of the last successful remediation.	bd7629fb-cac8-42fe-bcb1-e362c5a6****
AccountId	integer	The ID of the Alibaba Cloud account.	100931896542****
AggregatorId	string	The ID of the account group.	ca-6b4a626622af0012****
LastSuccessfulInvocationType	string	The mode of the last successful remediation. Valid values: NON_EXECUTION: The remediation was not executed. AUTO_EXECUTION: The remediation was automatically executed. MANUAL_EXECUTION: The remediation was manually executed. NOT_CONFIG: The remediation was not configured.	AUTO_EXECUTION
RemediationId	string	The ID of the remediation setting.	crr-6b7c626622af0026****
InvokeType	string	The execution mode of the remediation. Valid values: NON_EXECUTION: The remediation is not executed. AUTO_EXECUTION: The remediation is automatically executed. MANUAL_EXECUTION: The remediation is manually executed. NOT_CONFIG: The remediation is not configured.	AUTO_EXECUTION
ConfigRuleId	string	The rule ID.	cr-6b7c626622af00b4****
LastSuccessfulInvocationTime	integer	The timestamp of the last successful remediation. Unit: milliseconds.	1625451393589
RemediaitonOriginParams	string	The converted format of the remediation setting parameters. This parameter is used only to convert the parameters of an OOS template.	{"bucketName": "{resourceId}", "regionId": "{regionId}", "permissionName": "private"}

Examples

Success response

JSON format

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

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.	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.