Domain name for API request: config.intl.tencentcloudapi.com.
This API is used to query the list of compliance packages for account groups.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: ListAggregateCompliancePacks. |
| Version | Yes | String | Common Params. The value used for this API: 2022-08-02. |
| Region | No | String | Common Params. This parameter is not required. |
| Limit | Yes | Integer | Quantity. |
| Offset | Yes | Integer | Offset. |
| AccountGroupId | Yes | String | Account group ID. |
| CompliancePackName | No | String | Compliance package name. |
| RiskLevel.N | No | Array of Integer | Risk level. Valid values: |
| Status | No | String | Compliance package status. Valid values: ACTIVE (active) and NO_ACTIVE (inactive). |
| ComplianceResult.N | No | Array of String | Evaluation status. Valid values: 'COMPLIANT' (compliant) |
| OrderType | No | String | Sorting type. Valid values: desc (descending) and asc (ascending). |
| IncludeCompliancePackRuleResult | No | String | Compliance package result inclusion definition Valid values:
Default value: empty This field is newly added. Therefore, leaving it unpassed or passing YES will default to returning compliance result data, and other valid values will be enriched later as appropriate. |
| Parameter Name | Type | Description |
|---|---|---|
| Total | Integer | Total. |
| Items | Array of ConfigCompliancePack | Details. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This API is used to query the list of compliance packages.
POST / HTTP/1.1
Host: config.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListAggregateCompliancePacks
<Common request parameters>
{
"Limit": 10,
"Offset": 1,
"AccountGroupId": "ca-asdasdad"
}{
"Response": {
"RequestId": "4348278a-b93d-434c-aabd-e8e923560203",
"Items": [
{
"CompliancePackId": "cp-xzfz0vu007feuhwi8auv",
"CompliancePackName": "Compliance1",
"ComplianceResult": "NON_COMPLIANT",
"CreateTime": "2022-11-16 14:11:48",
"Description": null,
"NoCompliantNames": [
A CAM sub-user must be associated with a user group.
],
"RiskLevel": 1,
"RuleCount": 1,
"Status": "ACTIVE"
}
],
"Total": 1
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| ResourceNotFound.AccountGroupIsNotExist | Account group does not exist. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback