All Products
Search
Document Center

Cloud Governance Center:ListEvaluationMetadata

Last Updated:Oct 30, 2024

Queries all available information about check items in a governance maturity check, including the name, ID, description, stage, resource metadata, and fixing guide.

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.

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

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The region ID.

cn-hangzhou
LanguagestringNo

The language. The information is returned in the specified language. Valid values:

  • en: English
  • zh: Chinese
zh

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

EvaluationMetadataarray<object>

The metadata of a governance maturity check.

EvaluationMetadataobject

The metadata of a governance maturity check.

Metadataarray<object>

The metadata objects of a specific metadata type.

Metadataobject

The metadata object of a specific metadata type.

Categorystring

The category of the check item.

Security
Descriptionstring

The description of the check item.

DisplayNamestring

The display name of the check item.

Idstring

The ID of the metadata.

pxgtda****
RecommendationLevelstring

The governance level of the check item.

High
RemediationMetadataobject

The metadata of the fixing task.

Remediationarray<object>

The fixing items.

Remediationobject

The fixing item.

Actionsarray<object>

The fixing operations.

Actionobject

The fixing operation.

Classificationstring

The fixing method.

Note This parameter is returned only if the value of RemediationType is Analysis.
UnusedAccessKeyInRamUser
CostDescriptionstring

The fixing cost.

Descriptionstring

The description of the fixing item.

Note This parameter is returned only if the value of RemediationType is Analysis.
Guidancearray<object>

The content of the fixing items.

Guidanceobject

The content of a fixing item.

ButtonNamestring

The display name of the fixing button.

ButtonRefstring

The navigation URL of the fixing button.

https://ram.console.aliyun.com/users
Contentstring

The fixing procedure.

Titlestring

The title of the fixing procedure.

Noticestring

The usage notes of the fixing item.

Suggestionstring

The fixing suggestion.

Note This parameter is returned only if the value of RemediationType is Analysis.
RemediationTypestring

The type of the fixing method. Valid values:

  • Manual: manual fixing
  • QuickFix: quick fixing
  • Analysis: auxiliary decision-making
Manual
ResourceMetadataobject

The metadata of the checked resources.

ResourcePropertyMetadataarray<object>

The metadata of the resource properties.

ResourcePropertyMetadataobject

The metadata of the resource property.

DisplayNamestring

The display name of the resource property.

PropertyNamestring

The name of the resource property.

AkLastUsedTime
PropertyTypestring

The type of the resource property.

String
Scopestring

The scope of the check item. Valid values:

  • Account: the check item in a single-account governance maturity check
  • ResourceDirectory: the check item in a multi-account governance maturity check
Account
Stagestring

The status of the check item. Valid values:

  • Released: The check item is released.
  • Beta: The check item is pre-released.
Released
Typestring

The type of the metadata. Valid values:

  • Metric: the check item
Metric
RequestIdstring

The request ID.

16B208DD-86BD-5E7D-AC93-FFD44B6FBDF1

Examples

Sample success responses

JSONformat

{
  "EvaluationMetadata": [
    {
      "Metadata": [
        {
          "Category": "Security",
          "Description": "",
          "DisplayName": "",
          "Id": "pxgtda****",
          "RecommendationLevel": "High",
          "RemediationMetadata": {
            "Remediation": [
              {
                "Actions": [
                  {
                    "Classification": "UnusedAccessKeyInRamUser",
                    "CostDescription": "",
                    "Description": "",
                    "Guidance": [
                      {
                        "ButtonName": "",
                        "ButtonRef": "https://ram.console.aliyun.com/users",
                        "Content": "",
                        "Title": ""
                      }
                    ],
                    "Notice": "",
                    "Suggestion": ""
                  }
                ],
                "RemediationType": "Manual"
              }
            ]
          },
          "ResourceMetadata": {
            "ResourcePropertyMetadata": [
              {
                "DisplayName": "",
                "PropertyName": "AkLastUsedTime",
                "PropertyType": "String"
              }
            ]
          },
          "Scope": "Account",
          "Stage": "Released"
        }
      ],
      "Type": "Metric"
    }
  ],
  "RequestId": "16B208DD-86BD-5E7D-AC93-FFD44B6FBDF1"
}

Error codes

HTTP status codeError codeError messageDescription
404InvalidEnterpriseRealName.NotFoundThe specified account has not passed enterprise real name verification. Please complete the verification for the account first.
500InternalErrorA system error occurred.

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