调用DescribeComplianceSummary接口查询合规结果统计概要。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeComplianceSummary

要执行的操作,取值:DescribeComplianceSummary。

MultiAccount Boolean false

企业管理账号是否查询成员账号的合规结果统计概要。取值:

  • true:是。企业管理账号查询资源目录中所有成员账号的合规结果统计概要。
  • false(默认值):否。企业管理账号查询当前账号的合规结果统计概要。
说明 当您使用个人版配置审计时,请忽略该参数。
MemberId Long 123456789

待查询合规结果统计概要归属的成员账号ID。默认为空。当MultiAccount设置为true时,该参数有效。

  • 当MemberId为空时,查询企业管理账号和所有成员账号的合规结果统计概要。
  • 当MemberId不为空时,查询指定成员账号的合规结果统计概要。
说明 当您使用个人版配置审计时,请忽略该参数。

返回数据

名称 类型 示例值 描述
ComplianceSummary Struct

合规结果统计概要。

ComplianceSummaryByConfigRule Struct

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

ComplianceSummaryTimestamp Long 1589853712165

合规结果统计的时间戳。

CompliantCount Integer 111

合规的规则数量。

NonCompliantCount Integer 12

不合规的规则数量。

TotalCount Long 123

规则总数。

ComplianceSummaryByResource Struct

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

ComplianceSummaryTimestamp Long 1589853712165

合规结果统计的时间戳。

CompliantCount Integer 1

合规的资源数量。

NonCompliantCount Integer 12

不合规的资源数量。

TotalCount Long 13

资源总数。

RequestId String CAEE6F34-DEDC-4AAA-AA8C-946D5D008735

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeComplianceSummary
&<公共请求参数>

正常返回示例

XML 格式

<DescribeComplianceSummaryResponse>
      <RequestId>CAEE6F34-DEDC-4AAA-AA8C-946D5D008735</RequestId>
      <ComplianceSummary>
            <ComplianceSummaryByResource>
                  <CompliantCount>29</CompliantCount>
                  <NonCompliantCount>581</NonCompliantCount>
                  <ComplianceSummaryTimestamp>1589853712165</ComplianceSummaryTimestamp>
            </ComplianceSummaryByResource>
            <ComplianceSummaryByConfigRule>
                  <TotalCount>79</TotalCount>
                  <CompliantCount>1</CompliantCount>
                  <NonCompliantCount>34</NonCompliantCount>
                  <ComplianceSummaryTimestamp>1589853712128</ComplianceSummaryTimestamp>
            </ComplianceSummaryByConfigRule>
      </ComplianceSummary>
      <HttpStatusCode>200</HttpStatusCode>
      <Success>true</Success>
</DescribeComplianceSummaryResponse>

JSON 格式

{
  "RequestId": "CAEE6F34-DEDC-4AAA-AA8C-946D5D008735",
  "ComplianceSummary": {
    "ComplianceSummaryByResource": {
      "CompliantCount": 29,
      "NonCompliantCount": 581,
      "ComplianceSummaryTimestamp": 1589853712165
    },
    "ComplianceSummaryByConfigRule": {
      "TotalCount": 79,
      "CompliantCount": 1,
      "NonCompliantCount": 34,
      "ComplianceSummaryTimestamp": 1589853712128
    }
  },
  "HttpStatusCode": 200,
  "Success": true
}

错误码

HttpCode 错误码 错误信息 描述
400 NoPermission You are not authorized to perform this operation. 您无权执行此操作。
503 ServiceUnavailable The request has failed due to a temporary failure of the server. 服务不可用。
404 AccountNotExisted Your account does not exist. 您的账号不存在。

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