ListAggregateCompliancePacks - Cloud Config - Alibaba Cloud Documentation Center

Queries the compliance packs in a specified account group.

Operation description

This topic provides an example of how to query the compliance packs in the account group ca-f632626622af0079****. The response shows that the account group contains the compliance pack cp-fdc8626622af00f9****.

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

list

*AggregateCompliancePack

acs:config:*:{#accountId}:aggregatecompliancepack/*

None

Request parameters

Parameter	Type	Required	Description	Example
Status	string	No	The status of the compliance pack. Valid values: ACTIVE: The compliance pack is active. CREATING: The compliance pack is being created.	ACTIVE
RiskLevel	integer	No	The risk level of the compliance pack. Valid values: 1: high 2: medium 3: low	1
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-f632626622af0079****
PageSize	integer	No	The number of entries to return on each page. Valid values: 1 to 100. Minimum value: 1. Default value: 10.	20
PageNumber	integer	No	The page number. Minimum value: 1. Default value: 1.	1
Tag	array<object>	No	The tags of the resource. You can add up to 20 tags to a resource.
	object	No	A tag of the resource. You can add up to 20 tags to a resource.
Key	string	No	The tag key.	key-1
Value	string	No	The tag value.	value-1

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

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	B5806142-3090-4F86-A84E-12B3FE52C1C4
CompliancePacksResult	object	The results of the query.
CompliancePacks	array<object>	The compliance packs.
	object
Status	string	The status of the compliance pack. Valid values: ACTIVE: The compliance pack is active. CREATING: The compliance pack is being created.	ACTIVE
RiskLevel	integer	The risk level of the compliance pack. Valid values: 1: high 2: medium 3: low	1
CompliancePackId	string	The compliance pack ID.	cp-fdc8626622af00f9****
Description	string	The description of the compliance pack.	Check the stability of Alibaba Cloud resources based on the high-availability infrastructure, capacity protection, change management, monitoring management, backup management, and fault isolation. This helps you identify issues at the earliest opportunity and improve stability and the efficiency of O&M.
CompliancePackName	string	The name of the compliance pack.	BestPracticesForResourceStability
AccountId	integer	The ID of the management account to which the compliance pack belongs.	100931896542****
AggregatorId	string	The ID of the account group.	ca-f632626622af0079****
CompliancePackTemplateId	string	The ID of the compliance pack template.	ct-484cff4e06a30062****
CreateTimestamp	integer	The timestamp when the compliance pack was created. Unit: milliseconds.	1624243657000
Tags	array<object>	The tag of the resource.
	object	The tag of the resource.
TagKey	string	The tag key.	key-1
TagValue	string	The tag value.	value-1
PageSize	integer	The number of entries returned per page.	10
PageNumber	integer	The page number.	1
TotalCount	integer	The total number of compliance packs.	1

Examples

Success response

JSON format

{
  "RequestId": "B5806142-3090-4F86-A84E-12B3FE52C1C4",
  "CompliancePacksResult": {
    "CompliancePacks": [
      {
        "Status": "ACTIVE",
        "RiskLevel": 1,
        "CompliancePackId": "cp-fdc8626622af00f9****",
        "Description": "Check the stability of Alibaba Cloud resources based on the high-availability infrastructure, capacity protection, change management, monitoring management, backup management, and fault isolation. This helps you identify issues at the earliest opportunity and improve stability and the efficiency of O&M.",
        "CompliancePackName": "BestPracticesForResourceStability",
        "AccountId": 0,
        "AggregatorId": "ca-f632626622af0079****",
        "CompliancePackTemplateId": "ct-484cff4e06a30062****",
        "CreateTimestamp": 1624243657000,
        "Tags": [
          {
            "TagKey": "key-1",
            "TagValue": "value-1"
          }
        ]
      }
    ],
    "PageSize": 10,
    "PageNumber": 1,
    "TotalCount": 1
  }
}

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.
400	Invalid.AggregatorId.Value	The specified AggregatorId is invalid.	The specified aggregator ID does not exist or you are not authorized to use the aggregator.
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.