All Products
Search

This Product

    Cloud Config:ListConfigRuleEvaluationResults

    Document Center

    Cloud Config:ListConfigRuleEvaluationResults

    Last Updated:Mar 08, 2023

    Queries the compliance evaluation result of resources based on a rule.

    Operation Description

    This topic provides an example on how to query the compliance evaluation result of resources based on a rule whose ID is cr-cac56457e0d900d3****. The returned result indicates that the i-hp3e4kvhzqn2s11t**** resource is evaluated as NON_COMPLIANT by using the rule. The resource is an Elastic Compute Service (ECS) instance.

    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 keyAssociation operation
    config:ListConfigRuleEvaluationResultsList
    • Config
      acs:config:*:{#accountId}:*
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ComplianceTypestringNo

    The compliance evaluation result of resources. Valid values:

    • COMPLIANT: The resources are evaluated as compliant.
    • NON_COMPLIANT: The resources are evaluated as non-compliant.
    • NOT_APPLICABLE: The rule does not apply to the resources.
    • INSUFFICIENT_DATA: No resource data is available.
    • IGNORED: The resource is ignored during compliance evaluation.
    		NON_COMPLIANT
    NextTokenstringNo

    The token that is used to initiate the next request. If the response to the current request is truncated, this token is used to initiate another request and obtain the remaining entries.``

    		IWBjqMYSy0is7zSMGu16****
    MaxResultsintegerNo

    The maximum number of entries to return in a request. Valid values: 1 to 100.

    		10
    ConfigRuleIdstringNo

    The ID of the rule.

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

    		cr-cac56457e0d900d3****
    CompliancePackIdstringNo

    The ID of the compliance package.

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

    		cp-f1e3326622af00cb****
    RegionsstringNo

    The ID of the region where the resources that you want to evaluate reside. Separate multiple region IDs with commas (,).

    		cn-shanghai
    ResourceTypesstringNo

    The type of the resources that you want to evaluate. Separate multiple resource types with commas (,).

    		ACS::ECS::Instane
    ResourceGroupIdsstringNo

    The ID of the resource group to which the resources that you want to evaluate belong. Separate multiple resource group IDs with commas (,).

    		rg-aek2indxn3g****

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

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		2A4A33BD-8186-4D60-91B9-42174EED75B5
    EvaluationResultsobject

    The compliance evaluation result returned.

    NextTokenstring

    The token that was used to initiate the next request.

    		IWBjqMYSy0is7zSMGu16****
    MaxResultsinteger

    The maximum number of entries returned per page.

    		10
    EvaluationResultListarray

    The details of the compliance evaluation result.

    object
    RiskLevelinteger

    The risk level of the resources that are not compliant with the rule. Valid values:

    • 1: high risk level
    • 2: medium risk level
    • 3: low risk level
    		1
    ComplianceTypestring

    The compliance evaluation result of the resources. Valid values:

    • COMPLIANT: The resources are evaluated as compliant.
    • NON_COMPLIANT: The resources are evaluated as non-compliant.
    • NOT_APPLICABLE: The rule does not apply to the resources.
    • INSUFFICIENT_DATA: No resource data is available.
    • IGNORED: The resource is ignored during compliance evaluation.
    		NON_COMPLIANT
    ResultRecordedTimestamplong

    The timestamp when the compliance evaluation result was recorded. Unit: milliseconds.

    		1622802307150
    Annotationstring

    The annotation to the resource that is evaluated as non-compliant. The following parameters may be returned:

    • configuration: the current resource configuration that is evaluated as non-compliant.
    • desiredValue: the expected resource configuration that is evaluated as compliant.
    • operator: the operator that compares the current configuration with the expected configuration of the resource.
    • property: the JSON path of the current configuration in the resource property struct.
    • reason: the reason why the resource is evaluated as non-compliant.
    		{\"configuration\":\"\",\"desiredValue\":\"\",\"operator\":\"IsNotStringEmpty\",\"property\":\"$.KeyPairName\",\"reason\":\"No property contains.\"}
    ConfigRuleInvokedTimestamplong

    The timestamp when the rule was triggered for the compliance evaluation. Unit: milliseconds.

    		1622802307081
    InvokingEventMessageTypestring

    The trigger type of the rule. Valid values:

    • ConfigurationItemChangeNotification: The rule is triggered by configuration changes.
    • ScheduledNotification: The rule is periodically triggered.
    		ConfigurationItemChangeNotification
    EvaluationResultIdentifierobject

    The identifier of the compliance evaluation result.

    OrderingTimestamplong

    The timestamp when the compliance evaluation was performed. Unit: milliseconds.

    		1622802307081
    EvaluationResultQualifierobject

    The information about the evaluated resource in the compliance evaluation result.

    ResourceOwnerIdlong

    The ID of the Alibaba Cloud account to which the resources belong.

    		120886317861****
    ConfigRuleArnstring

    The Alibaba Cloud Resource Name (ARN) of the rule.

    		acs:config::120886317861****:rule/cr-cac56457e0d900d3****
    ResourceTypestring

    The type of the resource.

    		ACS::ECS::Instance
    ConfigRuleNamestring

    The name of the rule.

    ResourceIdstring

    The ID of the resource.

    		i-hp3e4kvhzqn2s11t****
    ConfigRuleIdstring

    The ID of the rule.

    		cr-cac56457e0d900d3****
    ResourceNamestring

    The name of the resource.

    		iZuf6j91r34rnwawoox****
    RegionIdstring

    The ID of the region where the resource resides.

    		cn-hangzhou
    CompliancePackIdstring

    The ID of the compliance package to which the rule belongs.

    		cp-bcc33457e0d900d5****
    IgnoreDatestring

    The date on which the system automatically re-evaluates the ignored incompliant resources.

    NoteIf this parameter is left empty, the system does not automatically re-evaluate the ignored incompliant resources. You must manually re-evaluate the ignored incompliant resources.
    		2022-06-01
    RemediationEnabledboolean

    Indicates whether the remediation template is enabled. Valid values:

    • true: The remediation template is enabled.
    • false: The remediation template is disabled.
    		false

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "2A4A33BD-8186-4D60-91B9-42174EED75B5",
  "EvaluationResults": {
    "NextToken": "IWBjqMYSy0is7zSMGu16****",
    "MaxResults": 10,
    "EvaluationResultList": [
      {
        "RiskLevel": 1,
        "ComplianceType": "NON_COMPLIANT",
        "ResultRecordedTimestamp": 1622802307150,
        "Annotation": "{\\\"configuration\\\":\\\"\\\",\\\"desiredValue\\\":\\\"\\\",\\\"operator\\\":\\\"IsNotStringEmpty\\\",\\\"property\\\":\\\"$.KeyPairName\\\",\\\"reason\\\":\\\"No property contains.\\\"}",
        "ConfigRuleInvokedTimestamp": 1622802307081,
        "InvokingEventMessageType": "ConfigurationItemChangeNotification",
        "EvaluationResultIdentifier": {
          "OrderingTimestamp": 1622802307081,
          "EvaluationResultQualifier": {
            "ResourceOwnerId": 0,
            "ConfigRuleArn": "acs:config::120886317861****:rule/cr-cac56457e0d900d3****",
            "ResourceType": "ACS::ECS::Instance",
            "ConfigRuleName": "",
            "ResourceId": "i-hp3e4kvhzqn2s11t****",
            "ConfigRuleId": "cr-cac56457e0d900d3****",
            "ResourceName": "iZuf6j91r34rnwawoox****",
            "RegionId": "cn-hangzhou",
            "CompliancePackId": "cp-bcc33457e0d900d5****",
            "IgnoreDate": "2022-06-01"
          }
        },
        "RemediationEnabled": true
      }
    ]
  }
}

    Error codes

    HTTP status codeError codeError messageDescription
    400NoPermissionYou are not authorized to perform this operation.You are not authorized to perform this operation.
    404CloudConfigServiceRoleNotExistedThe CloudConfigServiceRole does not exist.The CloudConfig service role 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.