1. 接口描述
接口请求域名： config.tencentcloudapi.com 。
获取规则列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ListConfigRules。 |
| Version | 是 | String | 公共参数，本接口取值：2022-08-02。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Limit | 是 | Integer | 每页数量。 取值范围：1~200 示例值：10 |
| Offset | 是 | Integer | 偏移量。 取值范围：最小值为0 示例值：1 |
| OrderType | 否 | String | 排序类型(规则名称)。 倒序：desc， 顺序：asc 示例值：desc |
| RiskLevel.N | 否 | Array of Integer | 风险等级。 1：高风险， 2：中风险， 3：低风险。 示例值：[1,2] |
| State | 否 | String | 规则状态。 ACTIVE：启用 UN_ACTIVE：停用 示例值：ACTIVE |
| ComplianceResult.N | 否 | Array of String | 评估结果。 COMPLIANT：合规 NON_COMPLIANT：不合规 示例值：["COMPLIANT"] |
| RuleName | 否 | String | 规则名 示例值：规则1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Total | Integer | 总数 示例值：4 |
| Items | Array of ConfigRule | 详情 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取规则列表
获取规则列表
输入示例
POST / HTTP/1.1
Host: config.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
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
