Domain name for API request: config.intl.tencentcloudapi.com.
This API is used to query the list of rules 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: ListAggregateConfigRules. |
| 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 | Number of items per page. |
| Offset | Yes | Integer | Offset. |
| AccountGroupId | Yes | String | Account group ID. |
| OrderType | No | String | Sorting type. Valid values: desc (descending) and asc (ascending). |
| RiskLevel.N | No | Array of Integer | Risk level. Valid values: |
| State | No | String | Rule status. |
| ComplianceResult.N | No | Array of String | Evaluation results. |
| RuleName | No | String | Rule name. |
| RuleOwnerId | No | Integer | ID of the account to which the rule belongs. |
| Parameter Name | Type | Description |
|---|---|---|
| Total | Integer | Total. |
| Items | Array of ConfigRule | 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 rules for account groups.
POST / HTTP/1.1
Host: config.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListAggregateConfigRules
<Common request parameters>
{
"Offset": 0,
"Limit": 10,
"OrderType": "",
"RiskLevel": [],
"State": "ACTIVE",
"ComplianceResult": [
"COMPLIANT"
],
"RuleName": "",
"RuleOwnerId": 1,
"AccountGroupId": "ca-sdfs7734h24h3"
}{
"Response": {
"RequestId": "149e116a-90ef-45f3-9d5d-3d77fd1c9eb3",
"Items": [
{
"RegionsScope": [
"ap-shanghai"
],
"TagsScope": [
{
"TagKey": "tag1",
"TagValue": "tag2"
}
],
"ExcludeResourceIdsScope": [
"ins-asdasd"
],
"Annotation": null,
"RuleOwnerId": 23424,
"CompliancePackId": "cp-xzfz0vu007feuhwi8auv",
"CompliancePackName": "Compliance1",
"AccountGroupId": "ca-sdfs7734h24h3",
"AccountGroupName": "Account group"
"ComplianceResult": "NON_COMPLIANT",
"ConfigRuleId": "cr-13vkg9c31dixgabkepxe",
"ConfigRuleInvokedTime": null,
"ManageTriggerType": [
"SCHEDULE"
],
"CreateTime": "2022-11-16 14:25:01",
"Description": "If a user in CAM is bound with at least one user group, the rule is complied with."
"Identifier": "cam-user-group-bound",
"IdentifierType": "SYSTEM",
"InputParameter": [],
"Labels": [],
"ManageInputParameter": [],
"ResourceType": [
"QCS::CAM::User"
],
"RiskLevel": 3,
"RuleName": "A CAM sub-user must be associated with a user group",
"ServiceFunction": null,
"SourceCondition": [
{
"DesiredValue": "1",
"EmptyAs": "COMPLIANT",
"Operator": "GreaterOrEquals",
"Required": false,
"SelectPath": "$User.GroupBindNum"
}
],
"Status": "ACTIVE",
"TriggerType": [
{
"MaximumExecutionFrequency": "TwentyFour_Hours",
"MessageType": "ScheduledNotification"
}
]
}
],
"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 |
|---|---|
| InvalidParameter | Parameter error. |
| ResourceNotFound.AccountGroupIsNotExist | Account group does not exist. |
フィードバック