All Products
Search
Document Center

Cloud Config:ListAggregateRemediations

Last Updated:Apr 12, 2024

Queries a list of remediation templates for a rule in an account group.

Operation description

This topic provides an example on how to query the remediation templates of the rule whose ID is cr-6b7c626622af00b4**** in the account group whose ID is ca-6b4a626622af0012****.

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:ListAggregateRemediationsList
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ConfigRuleIdsstringYes

The rule IDs. Separate multiple rule IDs with commas (,).

For more information about how to obtain the ID of a rule, see ListAggregateConfigRules .

cr-6b7c626622af00b4****
AggregatorIdstringYes

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 parameters

ParameterTypeDescriptionExample
object

N/A.

RequestIdstring

The request ID.

0146963A-20C0-4E75-B93A-7D622B5FD7C8
Remediationsobject []

An array that contains remediation templates.

RemediationTemplateIdstring

The ID of the remediation template.

ACS-OSS-PutBucketAcl
RemediationSourceTypestring

The source of remediation template. Valid values:

  • ALIYUN: official template.
  • CUSTOM: custom template.
  • NONE: none.
ALIYUN
RemediationTypestring

The type of the remediation template. Valid values:

  • OOS: Operation Orchestration Service (official remediation).
  • FC: Function Compute (custom remediation).
OOS
LastSuccessfulInvocationIdstring

The ID of the last successful execution of the remediation template.

bd7629fb-cac8-42fe-bcb1-e362c5a6****
AccountIdlong

The ID of the Alibaba Cloud account to which the resource belongs.

100931896542****
AggregatorIdstring

The ID of the account group.

ca-6b4a626622af0012****
LastSuccessfulInvocationTypestring

The mode of the last successful execution of the remediation template. Valid values:

  • NON_EXECUTION: The remediation template is not executed.
  • AUTO_EXECUTION: The remediation template is automatically executed.
  • MANUAL_EXECUTION: The remediation template is manually executed.
  • NOT_CONFIG: The execution mode is not specified.
AUTO_EXECUTION
RemediationIdstring

The ID of the remediation template.

crr-6b7c626622af0026****
InvokeTypestring

The execution mode of the remediation template. Valid values:

  • NON_EXECUTION: The remediation template is not executed.
  • AUTO_EXECUTION: The remediation template is automatically executed.
  • MANUAL_EXECUTION: The remediation template is manually executed.
  • NOT_CONFIG: The execution mode is not specified.
AUTO_EXECUTION
ConfigRuleIdstring

The rule ID.

cr-6b7c626622af00b4****
LastSuccessfulInvocationTimelong

The timestamp of the last successful execution of the remediation template. Unit: milliseconds.

1625451393589
RemediaitonOriginParamsstring

The converted configuration of the remediation template. This parameter is returned only for an OOS remediation template.

{"bucketName": "{resourceId}", "regionId": "{regionId}", "permissionName": "private"}

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
404AccountNotExistedYour account does not exist.The specified account does not exist.
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.