Retrieves the information about all available governance check evaluation items, including names, IDs, descriptions, stages, resource detail metadata, and remediation guidance.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
governance:ListEvaluationMetadata |
get |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
No |
The region ID. |
cn-hangzhou |
| Language |
string |
No |
The language type. The governance check definitions are returned in this language. Valid values:
|
zh |
| LensCode |
string |
No |
The specialized check code. Valid values:
|
ack |
| TopicCode |
string |
No |
The governance topic code. |
ResourceUtilization |
| EvaluationDomain |
string |
No |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response. |
||
| EvaluationMetadata |
array<object> |
The metadata of the governance check definitions. |
|
|
array<object> |
The metadata of the governance check definitions. |
||
| Metadata |
array<object> |
The list of metadata objects under a specific metadata type. |
|
|
array<object> |
The list of metadata objects under a specific metadata type. |
||
| Category |
string |
The pillar to which the check item belongs. |
Security |
| Description |
string |
The description of the check item. |
If you use an AccessKey pair of an Alibaba Cloud account, you have full permissions that cannot be restricted by conditions such as source IP address or access time. Once leaked, the risk is extremely high. If an AccessKey pair exists for the Alibaba Cloud account, it is considered non-compliant. |
| DisplayName |
string |
The display name. |
An AccessKey pair is enabled for the Alibaba Cloud account. |
| Id |
string |
The random ID of the metadata. |
pxgtda**** |
| RecommendationLevel |
string |
The recommended governance level of the check item. |
High |
| RemediationMetadata |
object |
The remediation metadata. |
|
| Remediation |
array<object> |
The remediation item. |
|
|
array<object> |
The remediation item. |
||
| Actions |
array<object> |
The remediation actions. |
|
|
array<object> |
The remediation actions. |
||
| Classification |
string |
The category of the remediation method. Note
This parameter is returned only when |
UnusedAccessKeyInRamUser |
| CostDescription |
string |
The remediation cost. |
You are not charged for this operation. |
| Description |
string |
The remediation description. Note
This parameter is returned only when |
A RAM user has both console logon and an AccessKey pair enabled, but the AccessKey pair has never been used. |
| Guidance |
array<object> |
The remediation content. |
|
|
object |
The remediation content. |
||
| ButtonName |
string |
The display name of the remediation step button. |
Manual fix |
| ButtonRef |
string |
The URL that the remediation step button links to. |
https://ram.console.alibabacloud.com/users |
| Content |
string |
The content of the remediation step. |
You must replace the AccessKey pair of your Alibaba Cloud account. To do so, perform the following steps:1. Log on to the RAM console. In the left-side navigation pane, choose Identities > Users. On the Users page, click Create User.2. On the Create User page, enter a logon name and select OpenAPI Access for the Access Mode parameter.3. After the RAM user is created, save the AccessKey pair. Then, find the user that you created on the Users page and click Add Permissions in the Actions column. In the Grant Permission panel, find the AdministratorAccess policy and attach it to the RAM user.4. In a program, replace the AccessKey pair of the Alibaba Cloud account with the AccessKey pair of the RAM user created in the previous step and check whether the program runs as expected in the test environment.5. If the program runs as expected, publish the program to the production environment and disable the previous AccessKey pair of your Alibaba Cloud account. Then, check whether the program runs as expected.6. If the program runs as expected, delete the disabled AccessKey pair after the specified period of time, such as 90 days. |
| Title |
string |
The title of the remediation step. |
Scenario 3: AccessKey pair that is used within the last 90 days |
| Notice |
string |
The precautions for remediation. |
This governance item enables the Best Practices for AccessKey and Permission Governance compliance package in Cloud Config to check the settings and usage of AccessKey pairs, Alibaba Cloud accounts, and RAM users. |
| Suggestion |
string |
The remediation suggestion. Note
This parameter is returned only when |
Console logon is enabled for the RAM user and the RAM user owns an AccessKey pair, while the AccessKey pair has never been used by the RAM user. We recommend that you disable the AccessKey pair for 90 days. If no related issue occurs during this period, you can delete the AccessKey pair. |
| RemediationType |
string |
The remediation type. Valid values:
|
Manual |
| ResourceMetadata |
object |
The resource metadata of the check item. |
|
| ResourcePropertyMetadata |
array<object> |
The resource property metadata. |
|
|
object |
The resource property metadata. |
||
| DisplayName |
string |
The display name of the property. |
Last time the AccessKey pair was used |
| PropertyName |
string |
The name of the resource property. |
AkLastUsedTime |
| PropertyType |
string |
The type of the resource property. |
String |
| Scope |
string |
The scope to which the check item belongs. Valid values:
|
Account |
| Stage |
string |
The status of the check item. Valid values:
|
Released |
| TopicCode |
string |
The code of the associated governance topic. |
ResourceUtilization |
| Type |
string |
The metadata type. Valid values:
|
Metric |
| RequestId |
string |
The request ID. |
16B208DD-86BD-5E7D-AC93-FFD44B6FBDF1 |
Examples
Success response
JSON format
{
"EvaluationMetadata": [
{
"Metadata": [
{
"Category": "Security",
"Description": "If you use an AccessKey pair of an Alibaba Cloud account, you have full permissions that cannot be restricted by conditions such as source IP address or access time. Once leaked, the risk is extremely high. If an AccessKey pair exists for the Alibaba Cloud account, it is considered non-compliant.",
"DisplayName": "An AccessKey pair is enabled for the Alibaba Cloud account.",
"Id": "pxgtda****",
"RecommendationLevel": "High",
"RemediationMetadata": {
"Remediation": [
{
"Actions": [
{
"Classification": "UnusedAccessKeyInRamUser",
"CostDescription": "You are not charged for this operation.",
"Description": "A RAM user has both console logon and an AccessKey pair enabled, but the AccessKey pair has never been used.",
"Guidance": [
{
"ButtonName": "Manual fix",
"ButtonRef": "https://ram.console.alibabacloud.com/users",
"Content": "You must replace the AccessKey pair of your Alibaba Cloud account. To do so, perform the following steps:1. Log on to the RAM console. In the left-side navigation pane, choose Identities > Users. On the Users page, click Create User.2. On the Create User page, enter a logon name and select OpenAPI Access for the Access Mode parameter.3. After the RAM user is created, save the AccessKey pair. Then, find the user that you created on the Users page and click Add Permissions in the Actions column. In the Grant Permission panel, find the AdministratorAccess policy and attach it to the RAM user.4. In a program, replace the AccessKey pair of the Alibaba Cloud account with the AccessKey pair of the RAM user created in the previous step and check whether the program runs as expected in the test environment.5. If the program runs as expected, publish the program to the production environment and disable the previous AccessKey pair of your Alibaba Cloud account. Then, check whether the program runs as expected.6. If the program runs as expected, delete the disabled AccessKey pair after the specified period of time, such as 90 days.",
"Title": "Scenario 3: AccessKey pair that is used within the last 90 days"
}
],
"Notice": "This governance item enables the Best Practices for AccessKey and Permission Governance compliance package in Cloud Config to check the settings and usage of AccessKey pairs, Alibaba Cloud accounts, and RAM users.",
"Suggestion": "Console logon is enabled for the RAM user and the RAM user owns an AccessKey pair, while the AccessKey pair has never been used by the RAM user. We recommend that you disable the AccessKey pair for 90 days. If no related issue occurs during this period, you can delete the AccessKey pair."
}
],
"RemediationType": "Manual"
}
]
},
"ResourceMetadata": {
"ResourcePropertyMetadata": [
{
"DisplayName": "Last time the AccessKey pair was used",
"PropertyName": "AkLastUsedTime",
"PropertyType": "String"
}
]
},
"Scope": "Account",
"Stage": "Released",
"TopicCode": "ResourceUtilization"
}
],
"Type": "Metric"
}
],
"RequestId": "16B208DD-86BD-5E7D-AC93-FFD44B6FBDF1"
}
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.