DescribeEvaluationResults - Cloud Config - Alibaba Cloud Documentation Center

Queries the evaluation results of a rule.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
config:DescribeEvaluationResults	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ResourceType	string	No	The type of resource. If you query the compliance evaluation results of resources by resource type, you must specify this parameter. You can call the GetSupportedResourceTypes operation to query the resource types supported by Cloud Config. For more information, see GetSupportedResourceTypes . Note You must specify the ResourceType or ConfigRuleId parameter.	ACS::ECS::Instance
ResourceId	string	No	The resource ID. If you query the compliance evaluation results of resources by resource type, you must specify this parameter.	i-bp151g9tpto890zr****
ComplianceType	string	No	The compliance evaluation result. 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: The resource data is insufficient.	COMPLIANT
PageNumber	integer	No	The number of the page to return. Pages start from page 1.	1
PageSize	integer	No	The number of entries to return per page. Valid values: 1 to 100.	10
ConfigRuleId	string	No	The rule ID. If you query the compliance evaluation results of resources by rule, you must specify this parameter. Note You must specify the ResourceType or ConfigRuleId parameter.	cr-2da35180a8d1008e****
MultiAccount	boolean	No	This parameter is unavailable since 00:00:00 on June 30, 2021. Account group-related operations are provided as an alternative after 00:00:00 on May 30, 2021. If you are using this parameter, we recommend that you switch to account group-related operations after 00:00:00 on May 30, 2021. For information about account groups, see Overview .	false
MemberId	long	No	This parameter is unavailable since 00:00:00 on June 30, 2021. Account group-related operations are provided as an alternative after 00:00:00 on May 30, 2021. If you are using this parameter, we recommend that you switch to account group-related operations after 00:00:00 on May 30, 2021. For information about account groups, see Overview .	123456789

Response parameters

Parameter	Type	Description	Example
	object	N/A.
EvaluationResults	object	The information about the compliance evaluation results returned.
EvaluationResultList	array<object>	Indicates whether remediation is enabled. Valid values: true false
EvaluationResult	object
Annotation	string	The annotation to the resource that is evaluated to be non-compliant.	{"operator": "StringEquals", "property": "$.SslProtocol", "desiredValue": "on", "configuration": "['off']"}
ComplianceType	string	The compliance evaluation result of the resource. Valid values: COMPLIANT: The resource is evaluated to be compliant. NON_COMPLIANT: The resource is evaluated to be non-compliant. NOT_APPLICABLE: The rule does not apply to the resource. INSUFFICIENT_DATA: The resource data is insufficient.	COMPLIANT
ConfigRuleInvokedTimestamp	long	The timestamp that was generated when the rule was triggered.	1589941923258
EvaluationResultIdentifier	object	The identifier of the compliance evaluation result.
EvaluationResultQualifier	object	The information of the rule and the evaluated resource.
ConfigRuleArn	string	The Alibaba Cloud Resource Name (ARN) of the rule.	acs:config::120390217529**:config-rule/cr-2da35180a8d1008e**
ConfigRuleId	string	The ID of the rule.	cr-2da35180a8d1008e****
ConfigRuleName	string	The name of the rule.	test-rule-name
RegionId	string	The ID of the region.	cn-hangzhou
ResourceId	string	The ID of the evaluated resource.	i-bp151g9tpto890zr****
ResourceName	string	The type of the evaluated resource.	launch-advisor-20200330
ResourceType	string	The type of the evaluated resource.	ACS::ECS::Instance
OrderingTimestamp	long	The timestamp that was generated when the compliance evaluation was performed.	1589941923117
InvokingEventMessageType	string	The trigger type of the rule. Valid values: ConfigurationItemChangeNotification: The rule is triggered by configuration changes. ScheduledNotification: The rule is triggered as scheduled.	ConfigurationItemChangeNotification
RemediationEnabled	boolean	Specifies whether to enable the remediation template. Valid values: true false	false
ResultRecordedTimestamp	long	The timestamp that was generated when the compliance evaluation result was recorded.	1589941923432
RiskLevel	integer	The risk level of the non-compliant resource. Valid values: 1: high risk 2: medium risk 3: low risk	1
PageNumber	integer	The page number of the returned page. Pages start from page 1.	1
PageSize	integer	The number of entries returned per page. Valid values: 1 to 100.	10
TotalCount	long	The total number of compliance evaluation results.	2
RequestId	string	The request ID.	D296EE41-1143-4B13-83BB-909008100130

Examples

Sample success responses

JSONformat

{
  "EvaluationResults": {
    "EvaluationResultList": [
      {
        "Annotation": {
          "operator": "StringEquals",
          "property": "$.SslProtocol",
          "desiredValue": "on",
          "configuration": "['off']"
        },
        "ComplianceType": "COMPLIANT",
        "ConfigRuleInvokedTimestamp": 1589941923258,
        "EvaluationResultIdentifier": {
          "EvaluationResultQualifier": {
            "ConfigRuleArn": "acs:config::120390217529****:config-rule/cr-2da35180a8d1008e****",
            "ConfigRuleId": "cr-2da35180a8d1008e****",
            "ConfigRuleName": "test-rule-name",
            "RegionId": "cn-hangzhou",
            "ResourceId": "i-bp151g9tpto890zr****",
            "ResourceName": "launch-advisor-20200330",
            "ResourceType": "ACS::ECS::Instance"
          },
          "OrderingTimestamp": 1589941923117
        },
        "InvokingEventMessageType": "ConfigurationItemChangeNotification",
        "RemediationEnabled": false,
        "ResultRecordedTimestamp": 1589941923432,
        "RiskLevel": 1
      }
    ],
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 2
  },
  "RequestId": "D296EE41-1143-4B13-83BB-909008100130"
}

Error codes

HTTP status code	Error code	Error message	Description
400	NoPermission	You are not authorized to perform this operation.	You are not authorized to perform this operation.
404	CloudConfigServiceRoleNotExisted	The CloudConfigServiceRole 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.

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