查询规则的评估结果列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
config:DescribeEvaluationResults | get | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ResourceType | string | 否 | 资源类型。当您按资源类型查询资源评估结果时,必须配置该参数。 您可以通过 GetSupportedResourceTypes 接口获取配置审计支持的资源类型列表。更多信息,请参见 GetSupportedResourceTypes 。 说明
资源类型(ResourceType)和规则 ID(ConfigRuleId)二选一。
| ACS::ECS::Instance |
ResourceId | string | 否 | 资源 ID。当您按资源类型查询资源评估结果时,必须配置该参数。 | i-bp151g9tpto890zr**** |
ComplianceType | string | 否 | 合规类型。取值:
| COMPLIANT |
PageNumber | integer | 否 | 资源评估结果列表的页码。起始值:1。 | 1 |
PageSize | integer | 否 | 分页查询时设置的每页行数。取值范围:1~100。 | 10 |
ConfigRuleId | string | 否 | 规则 ID。当您按规则查询资源评估结果时,必须配置该参数。 说明
资源类型(ResourceType)和规则 ID(ConfigRuleId)二选一。
| cr-2da35180a8d1008e**** |
MultiAccount | boolean | 否 | 该参数计划于 2021 年 06 月 30 日 00 时 00 分 00 秒前下线,其替代功能账号组的 API 将于 2021 年 05 月 30 日 00 时 00 分 00 秒前上线。如果您正在使用该参数,建议您在 2021 年 05 月 30 日 00 时 00 分 00 秒之后切换为账号组的 API。关于账号组,请参见账号组。 | false |
MemberId | long | 否 | 该参数计划于 2021 年 06 月 30 日 00 时 00 分 00 秒前下线,其替代功能账号组的 API 将于 2021 年 05 月 30 日 00 时 00 分 00 秒前上线。如果您正在使用该参数,建议您在 2021 年 05 月 30 日 00 时 00 分 00 秒之后切换为账号组的 API。关于账号组,请参见账号组。 | 123456789 |
返回参数
示例
正常返回示例
JSON
格式
{
"EvaluationResults": {
"EvaluationResultList": [
{
"Annotation": {
"operator": "StringEquals",
"property": "$.SslProtocol",
"desiredValue": "on",
"configuration": "['off']"
},
"ComplianceType": "COMPLIANT",
"ConfigRuleInvokedTimestamp": 1589941923258,
"EvaluationResultIdentifier": {
"EvaluationResultQualifier": {
"ConfigRuleArn": "acs:config::120390217529****:config-rule/cr-2da35180a8d1008e****",
"ConfigRuleId": "cr-2da35180a8d1008e****",
"ConfigRuleName": "ECS实例开启释放保护",
"RegionId": "cn-hangzhou",
"ResourceId": "i-bp151g9tpto890zr****",
"ResourceName": "launch-advisor-20200330",
"ResourceType": "ACS::ECS::Instance"
},
"OrderingTimestamp": 1589941923117
},
"InvokingEventMessageType": "ConfigurationItemChangeNotification",
"RemediationEnabled": false,
"ResultRecordedTimestamp": 1589941923432,
"RiskLevel": 1
}
],
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 2
},
"RequestId": "D296EE41-1143-4B13-83BB-909008100130"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | NoPermission | You are not authorized to perform this operation. | 您无权执行此操作。 |
404 | CloudConfigServiceRoleNotExisted | The CloudConfigServiceRole does not exist. | - |
404 | AccountNotExisted | Your account does not exist. | - |
503 | ServiceUnavailable | The request has failed due to a temporary failure of the server. | 服务不可用。 |
访问错误中心查看更多错误码。