All Products
Search
Document Center

Cloud Config:GetResourceComplianceGroupByResourceType

Last Updated:Jun 17, 2024

Queries the evaluation results grouped by resource type for a rule.

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:GetResourceComplianceGroupByResourceTypeRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ConfigRuleIdsstringYes

The rule IDs. Separate multiple rule IDs with commas (,).

cr-a5c6626622af0058****

Response parameters

ParameterTypeDescriptionExample
object
ComplianceResultobject

The queried evaluation results.

ComplianceResultListobject []

The evaluation results grouped by resource type.

ResourceTypestring

The type of the evaluated resource.

ACS::ECS::Instance
Compliancesobject []

The queried evaluation results.

ComplianceTypestring

The evaluation result. 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 data is available.
COMPLIANT
Countlong

The total number of evaluation results.

1
RequestIdstring

The request ID.

84610B68-2DD3-5AF0-B68D-E1FA8F051F7D

Examples

Sample success responses

JSONformat

{
  "ComplianceResult": {
    "ComplianceResultList": [
      {
        "ResourceType": "ACS::ECS::Instance",
        "Compliances": [
          {
            "ComplianceType": "COMPLIANT",
            "Count": 1
          }
        ]
      }
    ]
  },
  "RequestId": "84610B68-2DD3-5AF0-B68D-E1FA8F051F7D"
}

Error codes

HTTP status codeError codeError messageDescription
400Invalid.AggregatorId.ValueThe specified AggregatorId is invalid.The specified aggregator ID does not exist or you are not authorized to use the aggregator.
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.