1. 接口描述
接口请求域名: config.tencentcloudapi.com 。
获取评估结果--规则维度(某个规则下资源的评估结果列表)
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ListConfigRuleEvaluationResults。 |
| Version | 是 | String | 公共参数,本接口取值:2022-08-02。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| ConfigRuleId | 是 | String | 规则ID 示例值:111 |
| Limit | 是 | Integer | 偏移量 示例值:10 |
| Offset | 是 | Integer | 当前页 示例值:1 |
| ResourceType.N | 否 | Array of String | 类型 示例值:QCS::CVM::Instance |
| ComplianceType.N | 否 | Array of String | 评估结果 COMPLIANT:合规 NON_COMPLIANT:不合规 示例值:["COMPLIANT"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Total | Integer | 总数 示例值:10 |
| Items | Array of EvaluationResult | 详情 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 某个规则下资源的评估结果列表
输入示例
POST / HTTP/1.1
Host: config.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListConfigRuleEvaluationResults
<公共请求参数>
{
"Offset": 0,
"Limit": 10,
"ConfigRuleId": "cr-2d3brhnvyazqb9j1el6o",
"ResourceType": [],
"ComplianceType": [
"NON_COMPLIANT"
]
}
输出示例
{
"Response": {
"RequestId": "46e3ce2c-0fd0-4403-97de-590d85408248",
"Items": [
{
"Annotation": {
"Configuration": "0",
"DesiredValue": "1",
"Operator": "GreaterOrEquals",
"Property": "$User.GroupBindNum"
},
"CompliancePackId": "",
"ComplianceType": "NON_COMPLIANT",
"ConfigRuleId": "cr-2d3brhnvyazqb9j1el6o",
"ConfigRuleInvokedTime": "2022-11-16 11:36:47",
"ConfigRuleName": "CAM访问管理子用户必须关联用户组",
"InvokingEventMessageType": "[{\"messageType\":\"ScheduledNotification\",\"maximumExecutionFrequency\":{\"value\":\"TwentyFour_Hours\"}}]",
"ResourceId": "100028282616",
"ResourceName": "2",
"ResourceRegion": "global",
"ResourceType": "QCS::CAM::User",
"ResultRecordedTime": "2022-11-16 11:36:44",
"RiskLevel": 3
}
],
"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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| ResourceNotFound.RuleIsNotExist | 规则不存在。 |