GetResourceComplianceByPack - Cloud Config - Alibaba Cloud Documentation Center

Operation description

This topic provides an example of how to query the compliance results for resources in the compliance package cp-541e626622af0087****. The response shows that 7 of the 10 resources are non-compliant.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

config:GetResourceComplianceByPack

get

*CompliancePack

acs:config:*:{#accountId}:compliancepack/{#CompliancePackId}

None

Request parameters

Parameter	Type	Required	Description	Example
CompliancePackId	string	Yes	The ID of the compliance package. For more information about how to get the ID of a compliance package, see ListCompliancePacks.	cp-541e626622af0087****

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

Response elements

Element	Type	Description	Example
	object	None
ResourceComplianceResult	object	The compliance results of the resources in the compliance package.
CompliancePackId	string	The ID of the compliance package.	cp-541e626622af0087****
InsufficientDataCount	integer	The total number of resources that the rules in the compliance package evaluate as Insufficient Data.	1
TotalCount	integer	The total number of resources.	10
NonCompliantCount	integer	The number of non-compliant resources.	7
CompliantCount	integer	The number of compliant resources. Note Note: A resource is counted each time a rule evaluates it as compliant. For example, if a resource is evaluated as compliant by two rules, it is counted twice.	1
NotApplicableCount	integer	The number of resources that are not applicable. Note Note: A resource is counted each time a rule evaluates it as not applicable. For example, if a resource is evaluated as not applicable by two rules, it is counted twice.	1
IgnoredCount	integer	The number of resources whose evaluation results are ignored.	1
RequestId	string	The request ID.	6EC7AED1-172F-42AE-9C12-295BC2ADB751

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	Invalid.CompliancePackId.Value	The specified CompliancePackId does not exist.	The specified compliance pack ID does not exist.
404	AccountNotExisted	Your account does not exist.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.	The request has failed due to a temporary failure of the server.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.