GetAggregateResourceComplianceByConfigRule - 查询账号组规则合规评估结果维度的合规概要 - 配置审计

接口说明

本文将提供一个示例，查询账号组ca-a4e5626622af0079****内规则cr-d369626622af008e****对资源的合规评估结果。返回结果显示，该规则共评估 10 个资源，其中 5 个资源合规。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

config:GetAggregateResourceComplianceByConfigRule

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
ComplianceType	string	否	合规评估结果。取值： COMPLIANT：合规。 NON_COMPLIANT：不合规。 NOT_APPLICABLE：不适用。 INSUFFICIENT_DATA：无数据。枚举值： NOT_APPLICABLE : 不适用 COMPLIANT : 合规 NON_COMPLIANT : 不合规 INSUFFICIENT_DATA : 无数据 IGNORED : 已忽略	COMPLIANT
ConfigRuleId	string	是	规则 ID。关于如何获取规则 ID，请参见 ListAggregateConfigRules 。	cr-d369626622af008e****
AggregatorId	string	是	账号组 ID。关于如何获取账号组 ID，请参见 ListAggregators 。	ca-a4e5626622af0079****
ResourceAccountId	integer	否	账号组内待查询资源所属的阿里云账号 ID。说明参数 ResourceAccountId 和 ResourceOwnerId 二选一，推荐使用本参数。	100931896542****

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

返回参数

名称	类型	描述	示例值
	object	无。
ComplianceResult	object	资源的评估结果。
TotalCount	integer	规则评估的资源总数。	10
Compliances	array<object>	资源的评估结果。
	object	无。
ComplianceType	string	合规评估结果。取值： COMPLIANT：合规。 NON_COMPLIANT：不合规。 NOT_APPLICABLE：不适用。 INSUFFICIENT_DATA：无数据。	COMPLIANT
Count	integer	资源数。例如：当`ComplianceType`为`COMPLIANT`时，表示评估结果为合规的资源数。	5
RequestId	string	请求 ID。	23306AB1-34E0-468F-BD7B-68D8AEAB754C

示例

正常返回示例

JSON格式

{
  "ComplianceResult": {
    "TotalCount": 10,
    "Compliances": [
      {
        "ComplianceType": "COMPLIANT",
        "Count": 5
      }
    ]
  },
  "RequestId": "23306AB1-34E0-468F-BD7B-68D8AEAB754C"
}

错误码

HTTP status code	错误码	错误信息	描述
400	Invalid.AggregatorId.Value	The specified AggregatorId is invalid.	账号组ID不存在或无权限使用该账号组。
404	AccountNotExisted	Your account does not exist.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.	服务不可用。

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

变更历史

更多信息，参考变更详情。