文档

ListAggregateConfigRuleEvaluationResults - 查询账号组规则的评估结果

更新时间:

从规则维度查询指定账号组内规则对资源的评估结果。

接口说明

本文将提供一个示例,查询账号组ca-d1e3326622af00cb****内规则cr-888f626622af00ae****对资源的评估结果。返回结果显示,规则对资源Bucket-test(存储空间)的评估结果为NON_COMPLIANT(不合规)。

调试

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

授权信息

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

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

请求参数

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

合规评估结果。取值:

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

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

IWBjqMYSy0is7zSMGu16****
MaxResultsinteger

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

10
ConfigRuleIdstring

规则 ID。

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

cr-888f626622af00ae****
AggregatorIdstring

账号组 ID。

关于如何获取账号组 ID,请参见 ListAggregators

ca-b1e6626622af00cb****
CompliancePackIdstring

合规包 ID。

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

cp-f1e3326622af00cb****
Regionsstring

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

cn-shanghai
ResourceTypesstring

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

ACS::ECS::Instance
ResourceGroupIdsstring

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

rg-aek2cqyzvuj****
ResourceAccountIdlong

账号组内待查询资源所属的阿里云账号 ID。

说明 参数 ResourceAccountId 和 ResourceOwnerId 二选一,推荐使用本参数。
100931896542****

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

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

A6662516-D056-4325-B6A7-CD3E89C97C39
EvaluationResultsobject

规则评估结果集合。

NextTokenstring

查询下一页使用的 Token。

IWBjqMYSy0is7zSMGu16****
MaxResultsinteger

每页的最大记录数。

10
EvaluationResultListobject []

规则评估结果列表。

RiskLevelinteger

规则风险等级。取值:

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

合规评估结果。取值:

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

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

1624869013065
Annotationstring

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

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

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

1624869012713
InvokingEventMessageTypestring

规则触发机制。取值:

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

规则评估结果标识符。

OrderingTimestamplong

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

说明 该时间为规则被触发执行评估的时间戳,即参数ConfigRuleInvokedTimestamp显示的时间。
1624869012713
EvaluationResultQualifierobject

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

ResourceOwnerIdlong

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

173808452267****
ConfigRuleArnstring

规则 ARN。

acs:config::100931896542****:rule/cr-888f626622af00ae****
ResourceTypestring

资源类型。

ACS::OSS::Bucket
ConfigRuleNamestring

规则名称。

OSS存储空间开启同城冗余存储
ResourceIdstring

资源 ID。

Bucket-test
ConfigRuleIdstring

规则 ID。

cr-888f626622af00ae****
ResourceNamestring

资源名称。

Bucket-test
RegionIdstring

资源归属的地域 ID。

cn-hangzhou
CompliancePackIdstring

规则所属的合规包 ID。

cr-7263fd26622af00bc****
IgnoreDatestring

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

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

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

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

示例

正常返回示例

JSON格式

{
  "RequestId": "A6662516-D056-4325-B6A7-CD3E89C97C39",
  "EvaluationResults": {
    "NextToken": "IWBjqMYSy0is7zSMGu16****",
    "MaxResults": 10,
    "EvaluationResultList": [
      {
        "RiskLevel": 1,
        "ComplianceType": "NON_COMPLIANT",
        "ResultRecordedTimestamp": 1624869013065,
        "Annotation": "{\\\"configuration\\\":\\\"LRS\\\",\\\"desiredValue\\\":\\\"ZRS\\\",\\\"operator\\\":\\\"StringEquals\\\",\\\"property\\\":\\\"$.DataRedundancyType\\\"}",
        "ConfigRuleInvokedTimestamp": 1624869012713,
        "InvokingEventMessageType": "ScheduledNotification",
        "EvaluationResultIdentifier": {
          "OrderingTimestamp": 1624869012713,
          "EvaluationResultQualifier": {
            "ResourceOwnerId": 0,
            "ConfigRuleArn": "acs:config::100931896542****:rule/cr-888f626622af00ae****",
            "ResourceType": "ACS::OSS::Bucket",
            "ConfigRuleName": "OSS存储空间开启同城冗余存储",
            "ResourceId": "Bucket-test",
            "ConfigRuleId": "cr-888f626622af00ae****",
            "ResourceName": "Bucket-test",
            "RegionId": "cn-hangzhou",
            "CompliancePackId": "cr-7263fd26622af00bc****",
            "IgnoreDate": "2022-06-01"
          }
        },
        "RemediationEnabled": false
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400NoPermissionYou are not authorized to perform this operation.您无权执行此操作。
400Invalid.AggregatorId.ValueThe specified AggregatorId is invalid.账号组ID不存在或无权限使用该账号组。
400Invalid.CompliancePackId.ValueThe specified CompliancePackId does not exist.合规包ID不存在。
404CloudConfigServiceRoleNotExistedThe CloudConfigServiceRole does not exist.配置审计的服务角色不存在。
404AccountNotExistedYour account does not exist.您的账号不存在。
503ServiceUnavailableThe request has failed due to a temporary failure of the server.服务不可用。

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

变更历史

变更时间变更内容概要操作
2023-04-12OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
    删除错误码:503
入参OpenAPI 入参发生变更
    新增入参:ResourceAccountId
  • 本页导读 (1)