All Products
Search
Document Center

Cloud Config:GetResourceComplianceByConfigRule

Last Updated:Mar 01, 2024

Queries the compliance evaluation result of a resource by using a rule.

Operation description

In this topic, the cr-d369626622af008e**** rule is used as an example. The return result shows that a total of 10 resources are evaluated by the rule and five of them are evaluated as 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:GetResourceComplianceByConfigRuleRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ComplianceTypestringNo

The compliance evaluation result of the resource. Valid values:

  • COMPLIANT: The resource is evaluated as compliant.
  • NON_COMPLIANT: The resource is evaluated as non-compliant.
  • NOT_APPLICABLE: The rule does not apply to the resource.
  • INSUFFICIENT_DATA: No resource data is available.
COMPLIANT
ConfigRuleIdstringYes

The ID of the rule.

For more information about how to obtain the ID of a rule, see ListConfigRules .

cr-d369626622af008e****

For information about common request parameters, see Common parameters.

Response parameters

ParameterTypeDescriptionExample
object
ComplianceResultobject

The compliance evaluation results returned.

TotalCountlong

The total number of evaluated resources.

10
Compliancesobject []

The information about the compliance evaluation.

ComplianceTypestring

The compliance evaluation result. Valid values:

  • COMPLIANT: The relevant resources are evaluated as compliant.
  • NON_COMPLIANT: The relevant resources are evaluated as non-compliant.
  • NOT_APPLICABLE: The rule does not apply to your resources.
  • INSUFFICIENT_DATA: No resource data is available.
COMPLIANT
Countinteger

The number of resources that have the compliance evaluation result. For example, if the value of the ComplianceType parameter is COMPLIANT, this parameter value indicates the number of compliant resources.

5
RequestIdstring

The ID of the request.

23306AB1-34E0-468F-BD7B-68D8AEAB753d

Examples

Sample success responses

JSONformat

{
  "ComplianceResult": {
    "TotalCount": 10,
    "Compliances": [
      {
        "ComplianceType": "COMPLIANT",
        "Count": 5
      }
    ]
  },
  "RequestId": "23306AB1-34E0-468F-BD7B-68D8AEAB753d"
}

Error codes

HTTP status codeError codeError messageDescription
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.