使用GetComplianceSummary API获取合规统计概览信息-配置审计-阿里云

查询当前账号下合规统计概览信息。

接口说明

本文将提供一个示例，查询当前账号组下资源及规则维度的合规统计概览信息。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

config:GetComplianceSummary

get

*全部资源

*

无

请求参数

名称

类型

必填

描述

示例值

当前API无需请求参数

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	CAEE6F34-DEDC-4BAA-AA8C-946D5D008737
ComplianceSummary	object	合规结果统计概览。
ComplianceSummaryByResource	object	资源维度的合规结果统计概览。
LowRiskRuleNonCompliantResourceCount	integer	低风险等级规则检测到的不合规资源数量。说明注意这个数量也许会大于用户账号下资源总量，因为计数口径的去重维度添加了规则维度，即同一资源被两个低风险规则评估为不合规，这里的数量就会+2。	2
NonCompliantCount	integer	不合规的资源数量。	12
ComplianceSummaryTimestamp	integer	合规结果统计时的时间戳。单位：毫秒。	1589853712165
TotalCount	integer	资源总数。	13
CompliantCount	integer	合规的资源数量。	1
HighRiskRuleNonCompliantResourceCount	integer	高风险等级规则检测到的不合规资源数量。说明注意这个数量也许会大于用户账号下资源总量，因为计数口径的去重维度添加了规则维度，即同一资源被两个规则评估为不合规，这里的数量就会+2。	2
MediumRiskRuleNonCompliantResourceCount	integer	中风险等级规则检测到的不合规资源数量。说明注意这个数量也许会大于用户账号下资源总量，因为计数口径的去重维度添加了规则维度，即同一资源被两个规则评估为不合规，这里的数量就会+2。	6
ComplianceSummaryByConfigRule	object	规则维度的合规结果统计概览。
CompliantCount	integer	合规的规则数量。	5
NonCompliantCount	integer	不合规的规则数量。	11
ComplianceSummaryTimestamp	integer	合规统计时的时间戳。单位：毫秒。	1589853712165
TotalCount	integer	规则总数。	16

示例

正常返回示例

JSON格式

{
  "RequestId": "CAEE6F34-DEDC-4BAA-AA8C-946D5D008737",
  "ComplianceSummary": {
    "ComplianceSummaryByResource": {
      "LowRiskRuleNonCompliantResourceCount": 2,
      "NonCompliantCount": 12,
      "ComplianceSummaryTimestamp": 1589853712165,
      "TotalCount": 13,
      "CompliantCount": 1,
      "HighRiskRuleNonCompliantResourceCount": 2,
      "MediumRiskRuleNonCompliantResourceCount": 6
    },
    "ComplianceSummaryByConfigRule": {
      "CompliantCount": 5,
      "NonCompliantCount": 11,
      "ComplianceSummaryTimestamp": 1589853712165,
      "TotalCount": 16
    }
  }
}

错误码

HTTP status code	错误码	错误信息	描述
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.	服务不可用。

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

变更历史

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