文档

ListEvaluationMetadata - 获取治理检测项信息

更新时间:

获取所有可用的治理检测评估项的信息,包括名称、ID、描述、阶段、资源明细元数据和修复指引。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
governance:ListEvaluationMetadataget
  • 全部资源
    *

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。

cn-hangzhou
Languagestring

语言类型。治理检测定义将以此语言返回。取值:

  • en:英文。
  • zh:中文。
zh

返回参数

名称类型描述示例值
object

返回结果。

EvaluationMetadataarray<object>

治理检测定义元数据。

EvaluationMetadataobject

治理检测定义元数据。

Metadataarray<object>

特定元数据类型下的元数据对象列表。

Metadataobject

特定元数据类型下的元数据对象列表。

Categorystring

检测项所属的支柱。

Security
Descriptionstring

检测项描述。

主账号 AccessKey 等同于主账号权限,无法进行条件限制(如访问来源 IP、访问时间等),一旦泄漏风险极大。有存在的主账号 AccessKey,则视为不合规。
DisplayNamestring

显示名称。

主账号存在启用的 AccessKey
Idstring

元数据随机 ID。

pxgtda****
RecommendationLevelstring

检测项推荐治理等级。

High
RemediationMetadataobject

修复元数据。

Remediationarray<object>

修复项。

Remediationobject

修复项。

Actionsarray<object>

修复动作。

Actionobject

修复动作。

Classificationstring

修复方式类别。

说明 仅当RemediationTypeAnalysis时返回该参数。
UnusedAccessKeyInRamUser
CostDescriptionstring

修复花费。

当前操作不产生费用
Descriptionstring

修复描述。

说明 仅当RemediationTypeAnalysis时返回该参数。
RAM 用户既启用控制台登录又保有子账号AK,且子账号AK从未使用。
Guidancearray<object>

修复内容。

Guidanceobject

修复内容。

ButtonNamestring

修复步骤按钮显示名称。

手动修复
ButtonRefstring

修复步骤按钮跳转链接。

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

修复步骤内容。

需进行腾挪操作,步骤如下:</br>1. 进入 RAM 控制台,「身份管理」-「用户」,单击「创建用户」。</br>2. 填写「登录名称」,下方「访问方式」,勾选 OpenAPI 调用访问。</br>3. 创建成功后,保存该 RAM 用户的 AccessKey,勾选该 RAM 用户,单击「添加权限」,在弹出的侧边栏中,添加 AdministratorAccess权限。</br>4. 在程序中将主账号 AccessKey 替换为上步骤中创建的 RAM 用户 AccessKey,在相应的测试环境中验证程序逻辑是否正常。</br>5. 如果验证通过,将程序发布到生产环境,并将主账号 AccessKey 禁用,观察应用是否正常。</br>6. 如果应用正常,则等待一定时间(如 3 个月),将禁用的主账号 AccessKey 删除。
Titlestring

修复步骤标题。

情况三:针对「90天内使用中的 AccessKey」
Noticestring

修复注意事项。

此治理项会在配置审计中开启AccessKey及权限治理最佳实践合规包,从AccessKey、阿里云账号、RAM用户的设置和使用方式等方面进行检测。
Suggestionstring

修复建议。

说明 仅当RemediationTypeAnalysis时返回该参数。
该RAM用户既启用控制台登录又保有子账号AK,且子账号AccessKey从未使用过,因此建议禁用该AccessKey。禁用90天后,如果没有发生与该AcccessKey相关的问题,则可以直接删除该AccessKey。
RemediationTypestring

修复类型。取值:

  • Manual:手动修复。
  • QuickFix:快速修复。
  • Analysis:辅助决策。
Manual
ResourceMetadataobject

检测项的资源元数据。

ResourcePropertyMetadataarray<object>

资源属性元数据。

ResourcePropertyMetadataobject

资源属性元数据。

DisplayNamestring

属性显示名称。

AccessKey 最后使用时间
PropertyNamestring

资源属性名称。

AkLastUsedTime
PropertyTypestring

资源属性类型。

String
Scopestring

检测项所属范围。取值:

  • Account:单账号检测项。
  • ResourceDirectory:多账号检测项。
Account
Stagestring

检测项所处状态。取值:

  • Released:正式。
  • Beta:预上线。
Released
Typestring

元数据类型。取值:

  • Metric:检测项。
Metric
RequestIdstring

请求 ID。

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

示例

正常返回示例

JSON格式

{
  "EvaluationMetadata": [
    {
      "Metadata": [
        {
          "Category": "Security",
          "Description": "主账号 AccessKey 等同于主账号权限,无法进行条件限制(如访问来源 IP、访问时间等),一旦泄漏风险极大。有存在的主账号 AccessKey,则视为不合规。",
          "DisplayName": "主账号存在启用的 AccessKey",
          "Id": "pxgtda****",
          "RecommendationLevel": "High",
          "RemediationMetadata": {
            "Remediation": [
              {
                "Actions": [
                  {
                    "Classification": "UnusedAccessKeyInRamUser",
                    "CostDescription": "当前操作不产生费用",
                    "Description": "RAM 用户既启用控制台登录又保有子账号AK,且子账号AK从未使用。",
                    "Guidance": [
                      {
                        "ButtonName": "手动修复",
                        "ButtonRef": "https://ram.console.aliyun.com/users",
                        "Content": "需进行腾挪操作,步骤如下:</br>1. 进入 RAM 控制台,「身份管理」-「用户」,单击「创建用户」。</br>2. 填写「登录名称」,下方「访问方式」,勾选 OpenAPI 调用访问。</br>3. 创建成功后,保存该 RAM 用户的 AccessKey,勾选该 RAM 用户,单击「添加权限」,在弹出的侧边栏中,添加 AdministratorAccess权限。</br>4. 在程序中将主账号 AccessKey 替换为上步骤中创建的 RAM 用户 AccessKey,在相应的测试环境中验证程序逻辑是否正常。</br>5. 如果验证通过,将程序发布到生产环境,并将主账号 AccessKey 禁用,观察应用是否正常。</br>6. 如果应用正常,则等待一定时间(如 3 个月),将禁用的主账号 AccessKey 删除。",
                        "Title": "情况三:针对「90天内使用中的 AccessKey」"
                      }
                    ],
                    "Notice": "此治理项会在配置审计中开启AccessKey及权限治理最佳实践合规包,从AccessKey、阿里云账号、RAM用户的设置和使用方式等方面进行检测。",
                    "Suggestion": "该RAM用户既启用控制台登录又保有子账号AK,且子账号AccessKey从未使用过,因此建议禁用该AccessKey。禁用90天后,如果没有发生与该AcccessKey相关的问题,则可以直接删除该AccessKey。"
                  }
                ],
                "RemediationType": "Manual"
              }
            ]
          },
          "ResourceMetadata": {
            "ResourcePropertyMetadata": [
              {
                "DisplayName": "AccessKey 最后使用时间",
                "PropertyName": "AkLastUsedTime",
                "PropertyType": "String"
              }
            ]
          },
          "Scope": "Account",
          "Stage": "Released"
        }
      ],
      "Type": "Metric"
    }
  ],
  "RequestId": "16B208DD-86BD-5E7D-AC93-FFD44B6FBDF1"
}

错误码

HTTP status code错误码错误信息描述
404InvalidEnterpriseRealName.NotFoundThe specified account has not passed enterprise real name verification. Please complete the verification for the account first.
500InternalErrorA system error occurred.

访问错误中心查看更多错误码。