文档

ListConfigRuleEvaluationResults - 查询规则评估结果

更新时间:

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

接口说明

本文将提供一个示例,查询规则cr-cac56457e0d900d3****对资源的评估结果。返回结果显示,规则对资源i-hp3e4kvhzqn2s11t****(ECS 实例)的评估结果为NON_COMPLIANT(不合规)。

调试

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

授权信息

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

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

请求参数

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

合规评估结果。取值:

  • COMPLIANT:合规。
  • NON_COMPLIANT:不合规。
  • NOT_APPLICABLE:不适用。
  • INSUFFICIENT_DATA:无数据。
  • IGNORED:已忽略。
NON_COMPLIANT
NextTokenstring

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

IWBjqMYSy0is7zSMGu16****
MaxResultsinteger

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

10
ConfigRuleIdstring

规则 ID。

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

cr-cac56457e0d900d3****
CompliancePackIdstring

合规包 ID。

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

cp-f1e3326622af00cb****
Regionsstring

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

cn-shanghai
ResourceTypesstring

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

ACS::ECS::Instane
ResourceGroupIdsstring

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

rg-aek2indxn3g****

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

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

规则评估结果。

NextTokenstring

查询下一页使用的 Token。

IWBjqMYSy0is7zSMGu16****
MaxResultsinteger

每页的最大记录数。

10
EvaluationResultListobject []

规则评估结果列表。

RiskLevelinteger

规则风险等级。取值:

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

合规评估结果。取值:

  • COMPLIANT:合规。
  • NON_COMPLIANT:不合规。
  • NOT_APPLICABLE:不适用。
  • INSUFFICIENT_DATA:无数据。
  • IGNORED:已忽略。
NON_COMPLIANT
ResultRecordedTimestamplong

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

1622802307150
Annotationstring

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

  • configuration:资源当前实际配置,即资源不合规配置。
  • desiredValue:资源期望配置,即资源合规配置。
  • operator:资源当前配置和期望配置之间的比较运算符。
  • property:当前配置在资源属性结构体中的 JSON 路径。
  • reason:资源不合规原因。
{\"configuration\":\"\",\"desiredValue\":\"\",\"operator\":\"IsNotStringEmpty\",\"property\":\"$.KeyPairName\",\"reason\":\"No property contains.\"}
ConfigRuleInvokedTimestamplong

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

1622802307081
InvokingEventMessageTypestring

规则触发机制。取值:

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

规则评估结果标识符。

OrderingTimestamplong

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

1622802307081
EvaluationResultQualifierobject

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

ResourceOwnerIdlong

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

120886317861****
ConfigRuleArnstring

规则 ARN。

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

资源类型。

ACS::ECS::Instance
ConfigRuleNamestring

规则名称。

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

资源 ID。

i-hp3e4kvhzqn2s11t****
ConfigRuleIdstring

规则 ID。

cr-cac56457e0d900d3****
ResourceNamestring

资源名称。

iZuf6j91r34rnwawoox****
RegionIdstring

资源归属的地域 ID。

cn-hangzhou
CompliancePackIdstring

规则所属的合规包 ID。

cp-bcc33457e0d900d5****
IgnoreDatestring

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

说明 为空表示不会自动恢复,需要您手动恢复。
2022-06-01
RemediationEnabledboolean

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

  • true:启用修正设置。
  • false:不启用修正设置。
false

示例

正常返回示例

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核数满足最低要求",
            "ResourceId": "i-hp3e4kvhzqn2s11t****",
            "ConfigRuleId": "cr-cac56457e0d900d3****",
            "ResourceName": "iZuf6j91r34rnwawoox****",
            "RegionId": "cn-hangzhou",
            "CompliancePackId": "cp-bcc33457e0d900d5****",
            "IgnoreDate": "2022-06-01"
          }
        },
        "RemediationEnabled": false
      }
    ]
  }
}

错误码

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

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

  • 本页导读 (1)