All Products
Search
Document Center

Cloud Config:GetResourceComplianceByPack

Last Updated:Mar 01, 2024

Queries the compliance evaluation results of resources evaluated based on a compliance package.

Operation description

This topic provides an example on how to query the compliance evaluation results of resources monitored by using the cp-541e626622af0087**** compliance package. The returned result shows a total of 10 resources and seven of them are evaluated as non-compliant.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
config:GetResourceComplianceByPackRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
CompliancePackIdstringYes

The ID of the compliance package.

For more information about how to obtain the ID of a compliance package, see ListCompliancePacks .

cp-541e626622af0087****

For more information about common request parameters, see Common parameters.

Response parameters

ParameterTypeDescriptionExample
object

N/A.

ResourceComplianceResultobject

The compliance evaluation results returned.

CompliancePackIdstring

The ID of the compliance package.

cp-541e626622af0087****
NonCompliantCountinteger

The number of non-compliant resources.

7
TotalCountinteger

The total number of resources.

10
RequestIdstring

The request ID.

6EC7AED1-172F-42AE-9C12-295BC2ADB751

Examples

Sample success responses

JSONformat

{
  "ResourceComplianceResult": {
    "CompliancePackId": "cp-541e626622af0087****",
    "NonCompliantCount": 7,
    "TotalCount": 10
  },
  "RequestId": "6EC7AED1-172F-42AE-9C12-295BC2ADB751"
}

Error codes

HTTP status codeError codeError messageDescription
400Invalid.CompliancePackId.ValueThe specified CompliancePackId does not exist.The specified compliance pack ID does not exist.
404AccountNotExistedYour account does not exist.The specified account does not exist.
503ServiceUnavailableThe request has failed due to a temporary failure of the server.The request has failed due to a temporary failure of the server.

For a list of error codes, visit the Service error codes.