文档

DescribeDiagnosticReports - 查询资源诊断报告列表

更新时间:

调用DescribeDiagnosticReports查询资源诊断报告列表。

调试

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

授权信息

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

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

请求参数

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

地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
ReportIdsarray

诊断报告 ID 列表。

string

诊断报告 ID 列表。最多支持 100 个 ID。

dr-uf6i0tv2refv8wz*****
ResourceIdsarray

资源 ID 列表。最多支持 100 个 ID。

string

资源 ID。

i-uf6i0tv2refv8wz*****
Statusstring

报告状态。取值范围:

  • InProgress:诊断中。
  • Failed:诊断失败。
  • Finished:诊断完成。
Finished
Severitystring

严重等级。取值范围:

  • Unknown:初始状态,表示未开始诊断或者诊断过程程序异常退出,无诊断结论。
  • Normal:诊断正常,没有发现问题。
  • Info:有关联信息,可能与异常相关。
  • Warn:有关联信息,可能导致异常。
  • Critical:有关键异常。
Normal
NextTokenstring

查询凭证(Token)。取值为上一次调用接口返回的NextToken参数值,初次调用接口时无需设置该参数。

caeba0bbb2be03f84eb48b699f0a4883
MaxResultsinteger

分页查询时每页行数。最大值为 100。

默认值:

  • 当不设置值时,默认值为 10。
  • 当设置的值大于 100 时,默认值为 100。
10

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE*****
NextTokenstring

本次调用返回的查询凭证值。

caeba0bbb2be03f84eb48b699f0a4883
Reportsobject []

诊断报告列表。

ResourceIdstring

资源 ID。

i-uf6i0tv2refv8wz*****
ResourceTypestring

资源类型。

instance
MetricSetIdstring

诊断指标集合 ID。

dms-bp17p0qwtr72zmu*****
StartTimestring

开始时间。调用 CreateDiagnosticReport 接口创建诊断报告时传入的参数。

2022-07-11T12:00:00Z
EndTimestring

结束时间。调用 CreateDiagnosticReport 接口创建诊断报告时传入的参数。

2022-07-11T14:00:00Z
ReportIdstring

诊断报告 ID。

dr-uf6i0tv2refv8wz*****
Statusstring

诊断报告状态。

Finished
CreationTimestring

诊断报告创建时间。

2022-07-11T12:00:00Z
FinishedTimestring

诊断报告结束时间。

2022-07-11T14:00:00Z
Severitystring

严重等级。取值范围:

  • Unknown:初始状态,表示未开始诊断或者诊断过程程序异常退出,无诊断结论。
  • Normal:诊断正常,没有发现问题。
  • Info:有关联信息,可能与异常相关。
  • Warn:有关联信息,可能导致异常。
  • Critical:有关键异常。
Normal
Issuesobject []

诊断问题列表。

MetricIdstring

诊断指标 ID。

GuestOS.WinFirewall
MetricCategorystring

诊断指标分类。

ECSService.GuestOS
IssueIdstring

诊断问题的唯一识别码。

GuestOS.CPU.HighUtiliz*****
Severitystring

诊断指标严重等级。严重等级由轻到重如下:

  • Info:有关联信息,可能与异常相关。
  • Warn:有关联信息,可能导致异常。
  • Critical:有关键异常。
Info

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE*****",
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "Reports": {
    "Report": [
      {
        "ResourceId": "i-uf6i0tv2refv8wz*****",
        "ResourceType": "instance",
        "MetricSetId": "dms-bp17p0qwtr72zmu*****",
        "StartTime": "2022-07-11T12:00:00Z",
        "EndTime": "2022-07-11T14:00:00Z",
        "ReportId": "dr-uf6i0tv2refv8wz*****",
        "Status": "Finished",
        "CreationTime": "2022-07-11T12:00:00Z",
        "FinishedTime": "2022-07-11T14:00:00Z",
        "Severity": "Normal",
        "Issues": {
          "Issue": [
            {
              "MetricId": "GuestOS.WinFirewall",
              "MetricCategory": "ECSService.GuestOS",
              "IssueId": "GuestOS.CPU.HighUtiliz*****",
              "Severity": "Info"
            }
          ]
        }
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-07-21新增 OpenAPI看变更集
  • 本页导读 (1)