接口请求域名： config.intl.tencentcloudapi.com 。
获取规则列表
默认接口请求频率限制：20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ListConfigRules。 |
| Version | 是 | String | 公共参数，本接口取值：2022-08-02。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Limit | 是 | Integer | 每页数量。 取值范围：1~200 |
| Offset | 是 | Integer | 偏移量。 取值范围：最小值为0 |
| OrderType | 否 | String | 排序类型(规则名称)。 倒序：desc， 顺序：asc |
| RiskLevel.N | 否 | Array of Integer | 风险等级。 1：高风险， 2：中风险， 3：低风险。 |
| State | 否 | String | 规则状态。 ACTIVE：启用 UN_ACTIVE：停用 |
| ComplianceResult.N | 否 | Array of String | 评估结果。 COMPLIANT：合规 NON_COMPLIANT：不合规 |
| RuleName | 否 | String | 规则名 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Total | Integer | 总数 |
| Items | Array of ConfigRule | 详情 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
获取规则列表
POST / HTTP/1.1
Host: config.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListConfigRules
<公共请求参数>
{
"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": "账号组",
"Annotation": null,
"CompliancePackId": "",
"CompliancePackName": null,
"ComplianceResult": "NON_COMPLIANT",
"ConfigRuleId": "cr-HQxxxxxxxhR0BxxxxGodh",
"ConfigRuleInvokedTime": null,
"CreateTime": "2024-11-15 14:21:47",
"Description": "CAM用户下不存在已禁用的 AccessKey，则符合规则。",
"ExcludeResourceIdsScope": [],
"Identifier": "cam-user-invalid-ak-check",
"IdentifierType": "SYSTEM",
"InputParameter": [],
"Labels": [
"用户",
"密钥"
],
"ManageInputParameter": [],
"ManageTriggerType": [
"ConfigurationItemChangeNotification"
],
"RegionsScope": [],
"ResourceType": [
"QCS::CAM::User"
],
"RiskLevel": 3,
"RuleName": "CAM用户下不存在已禁用的访问密钥AccessKey",
"RuleOwnerId": 84935363164,
"ServiceFunction": null,
"SourceCondition": [],
"Status": "ACTIVE",
"TagsScope": [],
"TriggerType": [
{
"MaximumExecutionFrequency": null,
"MessageType": "ConfigurationItemChangeNotification"
}
]
}
],
"Total": 1
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
文档反馈