全部产品
Search
文档中心

配置审计:GetComplianceSummary - 查询合规统计概览信息

更新时间:Nov 20, 2024

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

接口说明

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
当前API无需请求参数

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

CAEE6F34-DEDC-4BAA-AA8C-946D5D008737
ComplianceSummaryobject

合规结果统计概览。

ComplianceSummaryByResourceobject

资源维度的合规结果统计概览。

CompliantCountinteger

合规的资源数量。

1
NonCompliantCountinteger

不合规的资源数量。

12
ComplianceSummaryTimestamplong

合规结果统计时的时间戳。单位:毫秒。

1589853712165
TotalCountlong

资源总数。

13
ComplianceSummaryByConfigRuleobject

规则维度的合规结果统计概览。

CompliantCountinteger

合规的规则数量。

5
NonCompliantCountinteger

不合规的规则数量。

11
ComplianceSummaryTimestamplong

合规统计时的时间戳。单位:毫秒。

1589853712165
TotalCountlong

规则总数。

16

示例

正常返回示例

JSON格式

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

错误码

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

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