Query Governance Evaluation Results with ListEvaluationResults API - Cloud Governance Center - Alibaba Cloud - Agentic Cloud Governance Center

Get governance evaluation results and status.

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

governance:ListEvaluationResults

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AccountId	integer	No	Member account ID. This parameter is only applicable to multi-account evaluation mode.	176618589410****
RegionId	string	No	Region ID.	cn-hangzhou
Filters	array<object>	No	Filter conditions.
	object	No	Filter condition.
Key	string	No	Filter condition key. Valid values: ResourceId: Resource ID. ResourceName: Resource name. ResourceType: Resource type.	ResourceId
Values	array	No	List of filter condition values.
	string	No	Filter condition value.	c191**************b4f
SnapshotId	string	No	Evaluation snapshot ID.	es-bp1r**************
Scope	string	No	Governance maturity evaluation scope. Valid values: Account (default): Performs single-account governance maturity evaluation, evaluating only the current account. ResourceDirectory: Performs multi-account governance maturity evaluation, evaluating all member accounts in the resource directory. Before performing this operation, you must first upgrade to multi-account governance maturity evaluation.	ResourceDirectory
LensCode	string	No	Special evaluation code. Valid values: basic (default): Basic model (governance maturity) evaluation. ack: Container construction special evaluation. ai: Machine learning special evaluation. nis: Network service special evaluation.	basic
TopicCode	string	No	Governance topic code.	IdentityAndAccessManagement

Response elements

Element	Type	Description	Example
	object	Response result.
AccountId	integer	Member account ID.	176618589410****
RequestId	string	Request ID.	BD57329E-131A-59F4-8746-E1CD8D7B****
Results	object	Evaluation results, including overall evaluation status and sub-item evaluation results.
EvaluationTime	string	Overall evaluation end time (UTC).	2023-12-13T03:35:00Z
MetricResults	array<object>	Evaluation results.
	array<object>	Evaluation result.
ErrorInfo	object	The error message. Note This parameter is returned when the value of `Status` is `Failed`.
Code	string	The error code.	EcsInsightEnableFailed
Message	string	The error message.	Unable to enable ECS Insight due to a server error.
EvaluationTime	string	The time when the evaluation of the check item was completed. The time is in UTC.	2023-12-13T03:34:02Z
Id	string	The ID of the check item.	r7xdcu****
ResourcesSummary	object	A summary of the resource evaluation for the check item.
NonCompliant	integer	The number of non-compliant resources.	2
Result	number	The resource compliance rate for the check item.	0.67
Risk	string	The risk level. Valid values: Error: high risk. Warning: medium risk. None: no risk.	Error
Status	string	The evaluation status of the check item. Valid values: Running: The evaluation is in progress. Finished: The evaluation is complete. Failed: The evaluation failed.	Running
AccountSummary	object	A summary of the account evaluation for the check item.
NonCompliant	integer	The number of non-compliant accounts.	1
PotentialScoreIncrease	number	The potential score increase.	0.2
AvailableRemediation	array<object>	A list of available remediations.
	object
RemediationTemplateId	string	The ID of the remediation template.
Status	string	Overall evaluation status. Valid values: Running: Evaluation in progress. Finished: Evaluation completed. Failed: Evaluation failed.	Running
TotalScore	number	Overall score.	0.6453

Examples

Success response

JSON format

{
  "AccountId": 0,
  "RequestId": "BD57329E-131A-59F4-8746-E1CD8D7B****",
  "Results": {
    "EvaluationTime": "2023-12-13T03:35:00Z\n",
    "MetricResults": [
      {
        "ErrorInfo": {
          "Code": "EcsInsightEnableFailed",
          "Message": "Unable to enable ECS Insight due to a server error."
        },
        "EvaluationTime": "2023-12-13T03:34:02Z",
        "Id": "r7xdcu****",
        "ResourcesSummary": {
          "NonCompliant": 2
        },
        "Result": 0.67,
        "Risk": "Error",
        "Status": "Running",
        "AccountSummary": {
          "NonCompliant": 1
        },
        "PotentialScoreIncrease": 0.2,
        "AvailableRemediation": [
          {
            "RemediationTemplateId": ""
          }
        ]
      }
    ],
    "Status": "Running",
    "TotalScore": 0.6453
  }
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	A system error occurred.	A system error occurred.
404	InvalidEnterpriseRealName.NotFound	The specified account has not passed enterprise real name verification. Please complete the verification for the account first.	The specified account has not passed enterprise real-name verification. Please complete the verification for the account first.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.