調用DescribeComplianceSummary接口查詢當前賬號的合規結果統計概要。

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String 是 DescribeComplianceSummary

要執行的操作，取值：DescribeComplianceSummary。
MultiAccount Boolean 否 false

該參數計劃于2021年06月30日00時00分00秒前下線，其替代功能賬號組的API將于2021年05月30日00時00分00秒前上線。如果您正在使用該參數，建議您在2021年05月30日00時00分00秒之后切換為賬號組的API。關于賬號組，請參見賬號組。
MemberId Long 否 100931896542****

該參數計劃于2021年06月30日00時00分00秒前下線，其替代功能賬號組的API將于2021年05月30日00時00分00秒前上線。如果您正在使用該參數，建議您在2021年05月30日00時00分00秒之后切換為賬號組的API。關于賬號組，請參見賬號組。

返回數據

名稱 類型 示例值 描述
RequestId String CAEE6F34-DEDC-4AAA-AA8C-946D5D008735

請求ID。
ComplianceSummary Object

合規結果統計概要。
ComplianceSummaryByResource Object

資源維度的合規結果統計概要。
CompliantCount Integer 1

合規的資源數量。
NonCompliantCount Integer 12

不合規的資源數量。
ComplianceSummaryTimestamp Long 1589853712165

合規結果統計的時間戳。單位：毫秒。
TotalCount Long 13

資源總數。
ComplianceSummaryByConfigRule Object

規則維度的合規結果統計概要。
CompliantCount Integer 101

合規的規則數量。
NonCompliantCount Integer 12

不合規的規則數量。
ComplianceSummaryTimestamp Long 1589853712128

合規結果統計的時間戳。單位：毫秒。
TotalCount Long 113

規則總數。

示例

請求示例

http(s)://[Endpoint]/?Action=DescribeComplianceSummary
&<公共請求參數>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeComplianceSummaryResponse>
    <RequestId>CAEE6F34-DEDC-4AAA-AA8C-946D5D008735</RequestId>
    <ComplianceSummary>
        <ComplianceSummaryByResource>
            <CompliantCount>1</CompliantCount>
            <NonCompliantCount>12</NonCompliantCount>
            <ComplianceSummaryTimestamp>1589853712165</ComplianceSummaryTimestamp>
            <TotalCount>13</TotalCount>
        </ComplianceSummaryByResource>
        <ComplianceSummaryByConfigRule>
            <CompliantCount>101</CompliantCount>
            <NonCompliantCount>12</NonCompliantCount>
            <ComplianceSummaryTimestamp>1589853712128</ComplianceSummaryTimestamp>
            <TotalCount>113</TotalCount>
        </ComplianceSummaryByConfigRule>
    </ComplianceSummary>
</DescribeComplianceSummaryResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "CAEE6F34-DEDC-4AAA-AA8C-946D5D008735",
  "ComplianceSummary" : {
    "ComplianceSummaryByResource" : {
      "CompliantCount" : 1,
      "NonCompliantCount" : 12,
      "ComplianceSummaryTimestamp" : 1589853712165,
      "TotalCount" : 13
    },
    "ComplianceSummaryByConfigRule" : {
      "CompliantCount" : 101,
      "NonCompliantCount" : 12,
      "ComplianceSummaryTimestamp" : 1589853712128,
      "TotalCount" : 113
    }
  }
}

錯誤碼

HttpCode 錯誤碼 錯誤信息 描述
400 NoPermission You are not authorized to perform this operation. 您無權執行此操作。
404 AccountNotExisted Your account does not exist. 您的賬號不存在。
503 ServiceUnavailable The request has failed due to a temporary failure of the server. 服務不可用。

訪問錯誤中心查看更多錯誤碼。