ListConfigRuleEvaluationResults - 查询规则评估结果

从规则维度查询规则对资源的评估结果。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

config:ListConfigRuleEvaluationResults

list

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

ComplianceType

string

合规评估结果。取值:

  • COMPLIANT:合规。

  • NON_COMPLIANT:不合规。

  • NOT_APPLICABLE:不适用。

  • INSUFFICIENT_DATA:无数据。

  • IGNORED:已忽略。

NON_COMPLIANT

NextToken

string

当请求的返回结果被截断时,您可以使用NextToken再次发起请求,获取从当前截断位置之后的内容。

IWBjqMYSy0is7zSMGu16****

MaxResults

integer

单次请求返回结果的最大条数。取值范围:1~100。

10

ConfigRuleId

string

规则 ID。

关于如何获取规则 ID,请参见 ListConfigRules

cr-cac56457e0d900d3****

CompliancePackId

string

合规包 ID。

关于如何获取合规包 ID,请参见 ListCompliancePacks

cp-f1e3326622af00cb****

Regions

string

评估资源所属地域,多个地域之间用半角逗号(,)分隔。

cn-shanghai

ResourceTypes

string

评估资源的资源类型,多个资源类型之间用半角逗号(,)分隔。

ACS::ECS::Instance

ResourceGroupIds

string

评估资源所属的资源组 ID,多个资源组 ID 之间用半角逗号(,)分隔。

rg-aek2indxn3g****

关于公共请求参数的详情,请参见公共参数

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

2A4A33BD-8186-4D60-91B9-42174EED75B5

EvaluationResults

object

规则评估结果。

NextToken

string

查询下一页使用的 Token。

IWBjqMYSy0is7zSMGu16****

MaxResults

integer

每页的最大记录数。

10

EvaluationResultList

array<object>

规则评估结果列表。

object

无。

RiskLevel

integer

规则风险等级。取值:

  • 1:高风险。

  • 2:中风险。

  • 3:低风险。

1

ComplianceType

string

合规评估结果。取值:

  • COMPLIANT:合规。

  • NON_COMPLIANT:不合规。

  • NOT_APPLICABLE:不适用。

  • INSUFFICIENT_DATA:无数据。

  • IGNORED:已忽略。

NON_COMPLIANT

ResultRecordedTimestamp

integer

产生资源评估结果的时间戳。单位:毫秒。

1622802307150

Annotation

string

不合规资源的补充信息。可能包含以下信息:

  • configuration:资源当前实际配置,即资源不合规配置。

  • desiredValue:资源期望配置,即资源合规配置。

  • operator:资源当前配置和期望配置之间的比较运算符。

  • property:当前配置在资源属性结构体中的 JSON 路径。

  • reason:资源不合规原因。

{\"configuration\":\"\",\"desiredValue\":\"\",\"operator\":\"IsNotStringEmpty\",\"property\":\"$.KeyPairName\",\"reason\":\"No property contains.\"}

ConfigRuleInvokedTimestamp

integer

规则被触发执行评估的时间戳。单位:毫秒。

1622802307081

InvokingEventMessageType

string

规则触发机制。取值:

  • ConfigurationItemChangeNotification:配置变更。

  • ScheduledNotification:周期执行。

  • Manual:手动触发。

ConfigurationItemChangeNotification

EvaluationResultIdentifier

object

规则评估结果标识符。

OrderingTimestamp

integer

时间轴展示的时间戳。单位:毫秒。

1622802307081

EvaluationResultQualifier

object

规则评估结果中的资源信息。

ResourceOwnerId

integer

资源归属的阿里云账号 ID。

120886317861****

ConfigRuleArn

string

规则 ARN。

acs:config::120886317861****:rule/cr-cac56457e0d900d3****

ResourceType

string

资源类型。

ACS::ECS::Instance

ConfigRuleName

string

规则名称。

ECS实例CPU核数满足最低要求

ResourceGroupId

string

ConfigRuleId

string

规则 ID。

cr-cac56457e0d900d3****

ResourceName

string

资源名称。

iZuf6j91r34rnwawoox****

RegionId

string

资源归属的地域 ID。

cn-hangzhou

CompliancePackId

string

规则所属的合规包 ID。

cp-bcc33457e0d900d5****

IgnoreDate

string

已忽略评估结果的自动恢复日期。

说明

为空表示不会自动恢复,需要您手动恢复。

2022-06-01

ResourceId

string

资源 ID。

i-hp3e4kvhzqn2s11t****

RemediationEnabled

boolean

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

  • true:启用修正设置。

  • false:不启用修正设置。

false

EvaluationId

string

评估结果的唯一 ID

00000089-4e0d-58b5-a96a-8e54112110f3

LastNonCompliantRecordTimestamp

integer

最近一次不合规的开始时间

1744696665000

示例

正常返回示例

JSON格式

{
  "RequestId": "2A4A33BD-8186-4D60-91B9-42174EED75B5",
  "EvaluationResults": {
    "NextToken": "IWBjqMYSy0is7zSMGu16****",
    "MaxResults": 10,
    "EvaluationResultList": [
      {
        "RiskLevel": 1,
        "ComplianceType": "NON_COMPLIANT",
        "ResultRecordedTimestamp": 1622802307150,
        "Annotation": "{\\\"configuration\\\":\\\"\\\",\\\"desiredValue\\\":\\\"\\\",\\\"operator\\\":\\\"IsNotStringEmpty\\\",\\\"property\\\":\\\"$.KeyPairName\\\",\\\"reason\\\":\\\"No property contains.\\\"}",
        "ConfigRuleInvokedTimestamp": 1622802307081,
        "InvokingEventMessageType": "ConfigurationItemChangeNotification",
        "EvaluationResultIdentifier": {
          "OrderingTimestamp": 1622802307081,
          "EvaluationResultQualifier": {
            "ResourceOwnerId": 0,
            "ConfigRuleArn": "acs:config::120886317861****:rule/cr-cac56457e0d900d3****",
            "ResourceType": "ACS::ECS::Instance",
            "ConfigRuleName": "ECS实例CPU核数满足最低要求",
            "ResourceGroupId": "",
            "ConfigRuleId": "cr-cac56457e0d900d3****",
            "ResourceName": "iZuf6j91r34rnwawoox****",
            "RegionId": "cn-hangzhou",
            "CompliancePackId": "cp-bcc33457e0d900d5****",
            "IgnoreDate": "2022-06-01",
            "ResourceId": "i-hp3e4kvhzqn2s11t****"
          }
        },
        "RemediationEnabled": false,
        "EvaluationId": "00000089-4e0d-58b5-a96a-8e54112110f3",
        "LastNonCompliantRecordTimestamp": 1744696665000
      }
    ]
  }
}

错误码

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. 服务不可用。

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

变更历史

更多信息,参考变更详情