DescribeComplianceSummary - Cloud Config - Alibaba Cloud Documentation Center

Queries the summary of compliance evaluations of the current Alibaba Cloud account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeComplianceSummary	The operation that you want to perform. Set the value to DescribeComplianceSummary.
MultiAccount	Boolean	No	false	This parameter is unavailable since 00:00:00 on June 30, 2021. Account group-related operations are provided as an alternative after 00:00:00 on May 30, 2021. If you are using this parameter, we recommend that you switch to account group-related operations after 00:00:00 on May 30, 2021. For information about account groups, see Overview.
MemberId	Long	No	100931896542****	This parameter is unavailable since 00:00:00 on June 30, 2021. Account group-related operations are provided as an alternative after 00:00:00 on May 30, 2021. If you are using this parameter, we recommend that you switch to account group-related operations after 00:00:00 on May 30, 2021. For information about account groups, see Overview.

Response parameters


Parameter	Type	Example	Description
RequestId	String	CAEE6F34-DEDC-4AAA-AA8C-946D5D008735	The request ID.
ComplianceSummary	Object		The summary of compliance evaluations.
ComplianceSummaryByResource	Object		The summary of compliance evaluations from the resource dimension.
CompliantCount	Integer	1	The number of resources evaluated as compliant.
NonCompliantCount	Integer	12	The number of resources evaluated as non-compliant.
ComplianceSummaryTimestamp	Long	1589853712165	The timestamp when the summary was recorded. Unit: milliseconds.
TotalCount	Long	13	The total number of resources.
ComplianceSummaryByConfigRule	Object		The summary of compliance evaluations from the rule dimension.
CompliantCount	Integer	101	The number of rules evaluated as compliant.
NonCompliantCount	Integer	12	The number of rules evaluated as non-compliant.
ComplianceSummaryTimestamp	Long	1589853712128	The timestamp when the summary was recorded. Unit: milliseconds.
TotalCount	Long	113	The total number of rules.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeComplianceSummary
&<Common request parameters>

Sample success responses

XML format

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 format

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
    }
  }
}

Error codes


HTTP status code	Error code	Error message	Description
400	NoPermission	You are not authorized to perform this operation.	You do not have the permissions to perform the specified operation.
404	AccountNotExisted	Your account does not exist.	Your account does not exist.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.	The service is unavailable.

For a list of error codes, see Service error codes.