DescribeEvaluationResults - 查询规则评估结果

查询规则的评估结果列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
config:DescribeEvaluationResultsget
*全部资源
*

请求参数

名称类型必填描述示例值
ResourceTypestring

资源类型。当您按资源类型查询资源评估结果时,必须配置该参数。

您可以通过 GetSupportedResourceTypes 接口获取配置审计支持的资源类型列表。更多信息,请参见 GetSupportedResourceTypes

说明 资源类型(ResourceType)和规则 ID(ConfigRuleId)二选一。
ACS::ECS::Instance
ResourceIdstring

资源 ID。当您按资源类型查询资源评估结果时,必须配置该参数。

i-bp151g9tpto890zr****
ComplianceTypestring

合规类型。取值:

  • COMPLIANT:合规。
  • NON_COMPLIANT:不合规。
  • NOT_APPLICABLE:不适用。
  • INSUFFICIENT_DATA:数据不充分。
COMPLIANT
PageNumberinteger

资源评估结果列表的页码。起始值:1。

1
PageSizeinteger

分页查询时设置的每页行数。取值范围:1~100。

10
ConfigRuleIdstring

规则 ID。当您按规则查询资源评估结果时,必须配置该参数。

说明 资源类型(ResourceType)和规则 ID(ConfigRuleId)二选一。
cr-2da35180a8d1008e****
MultiAccountboolean

该参数计划于 2021 年 06 月 30 日 00 时 00 分 00 秒前下线,其替代功能账号组的 API 将于 2021 年 05 月 30 日 00 时 00 分 00 秒前上线。如果您正在使用该参数,建议您在 2021 年 05 月 30 日 00 时 00 分 00 秒之后切换为账号组的 API。关于账号组,请参见账号组

false
MemberIdlong

该参数计划于 2021 年 06 月 30 日 00 时 00 分 00 秒前下线,其替代功能账号组的 API 将于 2021 年 05 月 30 日 00 时 00 分 00 秒前上线。如果您正在使用该参数,建议您在 2021 年 05 月 30 日 00 时 00 分 00 秒之后切换为账号组的 API。关于账号组,请参见账号组

123456789

返回参数

名称类型描述示例值
object

无。

EvaluationResultsobject

资源评估结果。

EvaluationResultListarray<object>

资源评估结果列表。

EvaluationResultobject

无。

Annotationstring

不合规资源的补充信息。

{"operator": "StringEquals", "property": "$.SslProtocol", "desiredValue": "on", "configuration": "['off']"}
ComplianceTypestring

合规类型。取值:

  • COMPLIANT:合规。
  • NON_COMPLIANT:不合规。
  • NOT_APPLICABLE:不适用。
  • INSUFFICIENT_DATA:数据不充分。
COMPLIANT
ConfigRuleInvokedTimestamplong

调用规则评估资源时的时间戳。

1589941923258
EvaluationResultIdentifierobject

资源评估结果标识符。

EvaluationResultQualifierobject

规则评估的资源范围。

ConfigRuleArnstring

规则 ARN。

acs:config::120390217529****:config-rule/cr-2da35180a8d1008e****
ConfigRuleIdstring

规则 ID。

cr-2da35180a8d1008e****
ConfigRuleNamestring

规则名称。

ECS实例开启释放保护
RegionIdstring

地域 ID。

cn-hangzhou
ResourceIdstring

规则评估的资源 ID。

i-bp151g9tpto890zr****
ResourceNamestring

规则评估的资源名称。

launch-advisor-20200330
ResourceTypestring

规则评估的资源类型。

ACS::ECS::Instance
OrderingTimestamplong

时间轴展示的时间戳。

1589941923117
InvokingEventMessageTypestring

规则的触发机制。取值:

  • ConfigurationItemChangeNotification:配置变更。
  • ScheduledNotification:周期执行。
ConfigurationItemChangeNotification
RemediationEnabledboolean

修正设置是否启用。取值:

  • true

  • false

false
ResultRecordedTimestamplong

资源评估结果的时间戳。

1589941923432
RiskLevelinteger

风险等级。取值:

  • 1:高风险。
  • 2:中风险。
  • 3:低风险。
1
PageNumberinteger

资源评估结果列表的页码。起始值:1。

1
PageSizeinteger

分页查询时设置的每页行数。取值范围:1~100。

10
TotalCountlong

资源评估结果的总记录数。

2
RequestIdstring

请求 ID。

D296EE41-1143-4B13-83BB-909008100130

示例

正常返回示例

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错误码错误信息描述
400NoPermissionYou are not authorized to perform this operation.您无权执行此操作。
404CloudConfigServiceRoleNotExistedThe CloudConfigServiceRole does not exist.-
404AccountNotExistedYour account does not exist.-
503ServiceUnavailableThe request has failed due to a temporary failure of the server.服务不可用。

访问错误中心查看更多错误码。