Domain name for API request: config.intl.tencentcloudapi.com.
This example shows you how to query the rule list.
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: ListConfigRules. |
| 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 entries per page. Valid values: 1-200 |
| Offset | Yes | Integer | Offset. Value range: minimum value is 0 |
| OrderType | No | String | Sorting type (rule name). - desc: descending order. asc: ascending order. |
| RiskLevel.N | No | Array of Integer | Risk level. 1: High-risk 2: Medium-risk, 3: Low risk. |
| State | No | String | Rule Status. ACTIVE: enable UN_ACTIVE: Disabled |
| ComplianceResult.N | No | Array of String | Assessment result. COMPLIANT: compliant NON_COMPLIANT: non-compliance |
| RuleName | No | String | Rule Name |
| Parameter Name | Type | Description |
|---|---|---|
| Total | Integer | Total number. |
| 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 example shows you how to query the rule list.
POST / HTTP/1.1
Host: config.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListConfigRules
<Common request parameters>
{
"Offset": 0,
"Limit": 10,
"OrderType": "desc",
"RiskLevel": [
1
],
"State": "ACTIVE",
"ComplianceResult": [
"COMPLIANT"
],
"RuleName": "CAM"
}{
"Response": {
"RequestId": "107f8d51-7095-4a6f-b374-a8aa7743584b",
"Items": [
{
"AccountGroupId": "ca-324234",
"AccountGroupName": "Account group",
"Annotation": null,
"CompliancePackId": "",
"CompliancePackName": null,
"ComplianceResult": "NON_COMPLIANT",
"ConfigRuleId": "cr-HQxxxxxxxhR0BxxxxGodh",
"ConfigRuleInvokedTime": null,
"CreateTime": "2024-11-15 14:21:47",
"Description": "Comply with rules if no disabled AccessKey exists under the CAM user."
"ExcludeResourceIdsScope": [],
"Identifier": "cam-user-invalid-ak-check",
"IdentifierType": "SYSTEM",
"InputParameter": [],
"Labels": [
user
key
],
"ManageInputParameter": [],
"ManageTriggerType": [
"ConfigurationItemChangeNotification"
],
"RegionsScope": [],
"ResourceType": [
"QCS::CAM::User"
],
"RiskLevel": 3,
"RuleName": "No disabled access key exists under the CAM user"
"RuleOwnerId": 84935363164,
"ServiceFunction": null,
"SourceCondition": [],
"Status": "ACTIVE",
"TagsScope": [],
"TriggerType": [
{
"MaximumExecutionFrequency": null,
"MessageType": "ConfigurationItemChangeNotification"
}
]
}
],
"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. |
フィードバック