All Products
Search
Document Center

Cloud Config:ListAggregateCompliancePacks

Last Updated:Jan 26, 2024

Queries a list of compliance packages in an account group.

Operation description

In this topic, the ca-f632626622af0079**** account group is used as an example. The return result shows one compliance package whose ID is cp-fdc8626622af00f9****.

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

Request parameters

ParameterTypeRequiredDescriptionExample
StatusstringNo

The status of the one or more compliance packages to be queried. Valid values:

  • ACTIVE: compliance packages that are available for use.
  • CREATING: compliance packages that are being created.
ACTIVE
AggregatorIdstringYes

The ID of the account group.

For more information about how to obtain the ID of an account group, see ListAggregators .

ca-f632626622af0079****
PageSizeintegerNo

The number of entries per page.

Valid values: 1 to 100. Minimum value: 1. Default value: 10.

20
PageNumberintegerNo

The page number.

Pages start from page 1. Default value: 1.

1

For information about common request parameters, see Common parameters.

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

B5806142-3090-4F86-A84E-12B3FE52C1C4
CompliancePacksResultobject

The information about the compliance packages.

CompliancePacksobject []

The details of the compliance package.

Statusstring

The status of the compliance package. Valid values:

  • ACTIVE: The compliance package is available for use.
  • CREATING: The compliance package is being created.
ACTIVE
RiskLevelinteger

The risk level of the resources that are not compliant with the managed rules in the compliance package. Valid values:

  • 1: high risk level.
  • 2: medium risk level.
  • 3: low risk level.
1
CompliancePackIdstring

The ID of the compliance package.

cp-fdc8626622af00f9****
Descriptionstring

The description of the compliance package.

CompliancePackNamestring

The name of the compliance package.

AccountIdlong

The ID of the management account to which the compliance package belongs.

100931896542****
AggregatorIdstring

The ID of the account group.

ca-f632626622af0079****
CompliancePackTemplateIdstring

The ID of the compliance package template.

ct-5f26ff4e06a300c4****
CreateTimestamplong

The timestamp when the compliance package was created. Unit: milliseconds.

1624243657000
PageSizeinteger

The number of entries returned per page.

10
PageNumberinteger

The page number of the returned page.

1
TotalCountlong

The total number of compliance packages returned.

1

Examples

Sample success responses

JSONformat

{
  "RequestId": "B5806142-3090-4F86-A84E-12B3FE52C1C4",
  "CompliancePacksResult": {
    "CompliancePacks": [
      {
        "Status": "ACTIVE",
        "RiskLevel": 1,
        "CompliancePackId": "cp-fdc8626622af00f9****",
        "Description": "",
        "CompliancePackName": "",
        "AccountId": 0,
        "AggregatorId": "ca-f632626622af0079****",
        "CompliancePackTemplateId": "ct-5f26ff4e06a300c4****",
        "CreateTimestamp": 1624243657000
      }
    ],
    "PageSize": 10,
    "PageNumber": 1,
    "TotalCount": 1
  }
}

Error codes

HTTP status codeError codeError messageDescription
400NoPermissionYou are not authorized to perform this operation.You are not authorized to perform this operation.
400Invalid.AggregatorId.ValueThe specified AggregatorId is invalid.The specified aggregator ID does not exist or you are not authorized to use the aggregator.
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.