调用DescribeEvaluationResults接口查询规则评估结果。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeEvaluationResults

要执行的操作,取值:DescribeEvaluationResults。

ResourceType String ACS::ECS::Instance

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

您可以通过GetSupportedResourceTypes接口获取配置审计支持的资源类型列表,具体请参见GetSupportedResourceTypes

ResourceId String i-bp151g9tpto890zr****

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

ComplianceType String COMPLIANT

合规类型。取值:

  • COMPLIANT:合规
  • NON_COMPLIANT:不合规
  • NOT_APPLICABLE:不适用
  • INSUFFICIENT_DATA:数据不充分
PageNumber Integer 1

规则评估结果列表的页码。起始值:1。

PageSize Integer 10

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

ConfigRuleId String cr-2da35180a8d1008e****

规则ID。

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

MultiAccount Boolean false

企业管理账号是否查询成员账号的规则评估结果。取值:

  • true:是。企业管理账号查询资源目录中所有成员账号的规则评估结果。
  • false(默认值):否。企业管理账号查询当前账号的规则评估结果。
说明 当您使用个人版配置审计时,请忽略该参数。
MemberId Long 1234567

待查询规则归属的成员账号ID。默认为空。当MultiAccount设置为true时,该参数有效。

  • 当MemberId为空时,查询企业管理账号和所有成员账号的规则评估结果。
  • 当MemberId不为空时,查询指定成员账号的规则评估结果。
说明 当您使用个人版配置审计时,请忽略该参数。

返回数据

名称 类型 示例值 描述
EvaluationResults Struct

评估结果。

EvaluationResultList Array of EvaluationResult

评估结果列表。

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

不合规结果的补充信息。

ComplianceType String COMPLIANT

合规类型。取值:

  • COMPLIANT:合规
  • NON_COMPLIANT:不合规
  • NOT_APPLICABLE:不适用
  • INSUFFICIENT_DATA:数据不充分
ConfigRuleInvokedTimestamp Long 1589941923258

规则调用时的时间戳。

EvaluationResultIdentifier Struct

评估结果标识符。

EvaluationResultQualifier Struct

评估的资源范围。

ConfigRuleArn String acs:config::120390217529****:config-rule/cr-2da35180a8d1008e****

规则ARN。

ConfigRuleId String cr-2da35180a8d1008e****

规则ID。

ConfigRuleName String level3_protection-ecs-instances-in-vpc-8e****

规则名称。

RegionId String cn-hangzhou

地域ID。

ResourceId String i-bp151g9tpto890zr****

评估的资源ID。

ResourceType String ACS::ECS::Instance

评估的资源类型。

OrderingTimestamp Long 1589941923117

用于时间轴展示的时间戳。

InvokingEventMessageType String ConfigurationItemChangeNotification

规则的触发机制。取值:

  • ConfigurationItemChangeNotification:配置变更
  • ScheduledNotification:周期
ResultRecordedTimestamp Long 1589941923432

记录结果时的时间戳。

RiskLevel Integer 1

风险等级。取值:

  • 1:Critical
  • 2:Warning
  • 3:Info
PageNumber Integer 1

规则的评估结果列表的页码。起始值:1。

PageSize Integer 10

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

TotalCount Long 2

评估结果总数。

RequestId String 7A90353C-A64F-4914-A452-68995753F5C2

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeEvaluationResults
&<公共请求参数>

正常返回示例

XML 格式

<DescribeEvaluationResultsResponse>
      <RequestId>7A90353C-A64F-4914-A452-68995753F5C2</RequestId>
      <EvaluationResults>
            <EvaluationResultList>
                  <ConfigRuleInvokedTimestamp>1589941923258</ConfigRuleInvokedTimestamp>
                  <ComplianceType>COMPLIANT</ComplianceType>
                  <ResultRecordedTimestamp>1589941923432</ResultRecordedTimestamp>
                  <InvokingEventMessageType>ConfigurationItemChangeNotification</InvokingEventMessageType>
                  <EvaluationResultIdentifier>
                        <EvaluationResultQualifier>
                              <ConfigRuleId>cr-2da35180a8d1008e****</ConfigRuleId>
                              <ConfigRuleArn>acs:config::120390217529****:config-rule/cr-2da35180a8d1008e****</ConfigRuleArn>
                              <ResourceId>i-bp151g9tpto890zr****</ResourceId>
                              <ConfigRuleName>level3_protection-ecs-instances-in-vpc-8e0fc7</ConfigRuleName>
                              <ResourceType>ACS::ECS::Instance</ResourceType>
                        </EvaluationResultQualifier>
                        <OrderingTimestamp>1589941923117</OrderingTimestamp>
                  </EvaluationResultIdentifier>
                  <RiskLevel>1</RiskLevel>
                  <Annotation></Annotation>
            </EvaluationResultList>
            <EvaluationResultList>
                  <ConfigRuleInvokedTimestamp>1589941923258</ConfigRuleInvokedTimestamp>
                  <ComplianceType>COMPLIANT</ComplianceType>
                  <ResultRecordedTimestamp>1589941923629</ResultRecordedTimestamp>
                  <InvokingEventMessageType>ConfigurationItemChangeNotification</InvokingEventMessageType>
                  <EvaluationResultIdentifier>
                        <EvaluationResultQualifier>
                              <ConfigRuleId>cr-2da35180a8d1008e****</ConfigRuleId>
                              <ConfigRuleArn>acs:config::120390217529****:config-rule/cr-2da35180a8d1008e****</ConfigRuleArn>
                              <ResourceId>i-bp151g9tpto890zr****</ResourceId>
                              <ConfigRuleName>level3_protection-ecs-instance-no-public-ip-8e0fc7</ConfigRuleName>
                              <ResourceType>ACS::ECS::Instance</ResourceType>
                        </EvaluationResultQualifier>
                        <OrderingTimestamp>1589941923117</OrderingTimestamp>
                  </EvaluationResultIdentifier>
                  <RiskLevel>1</RiskLevel>
                  <Annotation></Annotation>
            </EvaluationResultList>
            <TotalCount>3</TotalCount>
            <PageSize>10</PageSize>
            <PageNumber>1</PageNumber>
      </EvaluationResults>
</DescribeEvaluationResultsResponse>

JSON 格式

{
    "RequestId": "7A90353C-A64F-4914-A452-68995753F5C2",
    "EvaluationResults": {
        "EvaluationResultList": [
            {
                "ConfigRuleInvokedTimestamp": 1589941923258,
                "ComplianceType": "COMPLIANT",
                "ResultRecordedTimestamp": 1589941923432,
                "InvokingEventMessageType": "ConfigurationItemChangeNotification",
                "EvaluationResultIdentifier": {
                    "EvaluationResultQualifier": {
                        "ConfigRuleId": "cr-2da35180a8d1008e****",
                        "ConfigRuleArn": "acs:config::120390217529****:config-rule/cr-2da35180a8d1008e****",
                        "ResourceId": "i-bp151g9tpto890zr****",
                        "ConfigRuleName": "level3_protection-ecs-instances-in-vpc-8e****",
                        "ResourceType": "ACS::ECS::Instance"
                    },
                    "OrderingTimestamp": 1589941923117
                },
                "RiskLevel": 1,
                "Annotation": ""
            },
            {
                "ConfigRuleInvokedTimestamp": 1589941923258,
                "ComplianceType": "COMPLIANT",
                "ResultRecordedTimestamp": 1589941923629,
                "InvokingEventMessageType": "ConfigurationItemChangeNotification",
                "EvaluationResultIdentifier": {
                    "EvaluationResultQualifier": {
                        "ConfigRuleId": "cr-2da35180a8d1008e****",
                        "ConfigRuleArn": "acs:config::120390217529****:config-rule/cr-2da35180a8d1008e****",
                        "ResourceId": "i-bp151g9tpto890zr****",
                        "ConfigRuleName": "level3_protection-ecs-instance-no-public-ip-8e****",
                        "ResourceType": "ACS::ECS::Instance"
                    },
                    "OrderingTimestamp": 1589941923117
                },
                "RiskLevel": 1,
                "Annotation": ""
            }
        ],
        "TotalCount": 3,
        "PageSize": 10,
        "PageNumber": 1
    }
}

错误码

HttpCode 错误码 错误信息 描述
404 CloudConfigServiceRoleNotExisted The CloudConfigServiceRole does not exist. 配置审计的服务角色不存在。
400 NoPermission You are not authorized to perform this operation. 您无权执行此操作。
503 ServiceUnavailable The request has failed due to a temporary failure of the server. 服务不可用。
404 AccountNotExisted Your account does not exist. 您的账号不存在。

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