Domain name for API request: config.intl.tencentcloudapi.com.
This API is used to create 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: AddAggregateConfigRule. |
| Version | Yes | String | Common Params. The value used for this API: 2022-08-02. |
| Region | No | String | Common Params. This parameter is not required. |
| Identifier | Yes | String | Rule template ID. The preset rule template is Identifier, and the custom rule is the serverless cloud function ARN (region:functionName). |
| IdentifierType | Yes | String | Rule template type. Valid values: SYSTEM and CUSTOMIZE. |
| RuleName | Yes | String | Rule name |
| ResourceType.N | Yes | Array of String | Resources supported by the rule. |
| TriggerType.N | Yes | Array of TriggerType | Trigger types. A maximum of two types are supported. |
| RiskLevel | Yes | Integer | Risk level 1: High-risk. 2: Medium-risk. 3: Low risk. |
| AccountGroupId | Yes | String | Account group ID. |
| InputParameter.N | No | Array of InputParameter | Input parameters |
| Description | No | String | Description |
| RegionScope.N | No | Array of String | Associated regions. |
| TagsScope.N | No | Array of Tag | Associated tag |
| ExcludeResourceIdsScope.N | No | Array of String | Excluded resource ID. |
| Parameter Name | Type | Description |
|---|---|---|
| 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. |
Add Rule
POST / HTTP/1.1
Host: config.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddAggregateConfigRule
<Common request parameters>
{
"Identifier": "cam-user-group-bound",
"IdentifierType": "SYSTEM",
"RuleName": "A CAM sub-user must be associated with a user group.",
"ResourceType": [
"QCS::CAM::User"
],
"RiskLevel": 3,
"Description": "If a user in CAM is bound with at least one user group, the rule is complied with."
"TriggerType": [
{
"MessageType": "ScheduledNotification",
"MaximumExecutionFrequency": "TwentyFour_Hours"
}
],
"InputParameter": [],
"AccountGroupId": "ca-sdfs7734h24h3"
}{
"Response": {
"RequestId": "da85d5e2-4432-4f02-9863-0ab07adeff33"
}
}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 |
|---|---|
| FailedOperation.RuleNameIsExist | Rule name already exists. |
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| ResourceNotFound.AccountGroupIsNotExist | Account group does not exist. |
| UnauthorizedOperation | Unauthorized operation. |
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