DescribeDiagnoseReport - 查询资源诊断报告

更新时间:
复制为 MD 格式

查询诊断报告

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

DiagnoseType

string

诊断类型。可选的有:

  • Performance:性能诊断

Performance

ResourceIds

array

资源 ID。

d-asb1s8***

string

资源 ID 列表。

d-bp14d1obw9qijunh8div

ReportIds

array

诊断报告 ID。

report-asb1s8***

string

诊断报告列表。

report-da21a****

StartTime

string

资源诊断的起始时间点。按照ISO 8601标准表示,并使用 UTC+0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

2024-08-26T01:00:00Z

EndTime

string

资源诊断的结束时间点。按照ISO 8601标准表示,并使用 UTC+0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

2024-08-26T02:06:00Z

Status

string

诊断报告状态。可选的值:

  • Running

  • Success

  • TimeOut

  • Fail

Running

RegionId

string

地域 ID。您可以调用 DescribeRegions 查询块存储数据洞察支持的地域列表。

cn-zhangjiakou

ClientToken

string

服务端生成的一串字符串,作为客户端进行请求的一个标识。

123e4567-e89b-12d3-a456-42665544****

MaxResults

integer

分页查询时每页的最大条目数。取值范围:1~30。

默认值:10。

10

NextToken

string

用来标记当前开始读取的位置。置空表示从头开始。

adf8a2534f1c0a23e0b5e8707e68181f

返回参数

名称

类型

描述

示例值

object

DescribeDiagnoseReportResponse

RequestId

string

请求 ID。

AAA478A0-BEE6-1D42-BEB6-A9CFEAD6****

TotalCount

integer

查询结果总条数。

10

NextToken

string

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

f07b150eadfa1d7a

Reports

array<object>

诊断报告列表。

array<object>

诊断报告列表。

Status

string

诊断报告状态。可能的值:

  • Running

  • Success

  • TimeOut

  • Fail

当 Status 为 Success 的时候,Severity 和 Events 字段有效。

Success

ReportId

string

诊断报告 ID。

report-sag8d****

ResourceType

string

资源类型。当前可能的值有:

  • Disk

Disk

Severity

string

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

  • Info:有关联信息,可能与异常相关。

  • Warn:有关联信息,可能导致异常。

  • Critical:有关键异常。

Warn

FinishedTime

integer

诊断报告结束时间。

1727239295

DiagnoseStartTime

integer

资源诊断的起始时间戳。

1727229294

ResourceId

string

资源 ID。

d-wz95ycu****

Events

array<object>

诊断出的问题列表。

object

诊断出的问题列表。

RecommendParams

string

事件发生后的推荐操作的参数。

4096

Description

string

事件描述。

test

RecommendAction

string

事件发生后的推荐操作。可能值:

  • ModifyDiskSpec:变配

  • CreateSnapshot:打快照

  • ResizeDisk:扩容

  • AdjustProvision:调节预配置等

  • ModifyInstanceSpec:实例变配

ResizeDisk

StartTime

integer

事件开始时间戳(毫秒级)。

1755756214000

Severity

string

诊断问题严重程度,严重等级由轻到重如下:

  • Info:有关联信息,可能与异常相关。

  • Warn:有关联信息,可能导致异常。

  • Critical:有关键异常。

Warn

EventName

string

问题名称。可能值:

  • NoSnapshot:数据保护

  • BurstIOTriggered:突发 IO

  • CostOptimizationNeeded:成本优化

  • DiskSpecNotMatchedWithInstance:实例与磁盘规格不匹配

  • DiskIONo4kAligned:非 4K 对齐读写

  • DiskIOHang:磁盘有 IOHang 发生

  • InstanceIOPSExceedInstanceMaxLimit:实例 IOPS 到达上限

  • InstanceBPSExceedInstanceMaxLimit:实例 BPS 到达上限

  • DiskIOPSExceedInstanceMaxLimit:磁盘 IOPS 到达实例上限

  • DiskBPSExceedInstanceMaxLimit:磁盘 BPS 到达实例上限

  • DiskIOPSExceedDiskMaxLimit:磁盘 IOPS 到达磁盘上限

  • DiskBPSExceedDiskMaxLimit:磁盘 BPS 到达磁盘上限

DiskIOPSExceedDiskMaxLimit

DiagnoseEndTime

integer

资源诊断的结束时间戳。

1727239294

CreationTime

integer

诊断报告创建时间。

1727239294

RegionId

string

地域 ID。

cn-zhangjiakou

DiagnoseType

string

诊断类型。

Performance

AliUid

integer

用户 ID。

196380451****

示例

正常返回示例

JSON格式

{
  "RequestId": "AAA478A0-BEE6-1D42-BEB6-A9CFEAD6****\n",
  "TotalCount": 10,
  "NextToken": "f07b150eadfa1d7a",
  "Reports": [
    {
      "Status": "Success",
      "ReportId": "report-sag8d****",
      "ResourceType": "Disk",
      "Severity": "Warn",
      "FinishedTime": 1727239295,
      "DiagnoseStartTime": 1727229294,
      "ResourceId": "d-wz95ycu****",
      "Events": [
        {
          "RecommendParams": "4096",
          "Description": "test",
          "RecommendAction": "ResizeDisk",
          "StartTime": 1755756214000,
          "Severity": "Warn",
          "EventName": "DiskIOPSExceedDiskMaxLimit"
        }
      ],
      "DiagnoseEndTime": 1727239294,
      "CreationTime": 1727239294,
      "RegionId": "cn-zhangjiakou",
      "DiagnoseType": "Performance",
      "AliUid": 0
    }
  ]
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParameter The parameter %s is invalid. 参数错误
400 InvalidParameter.Conflict The specified parameter %s and %s are not blank at the same time. 参数冲突
400 InvalidParameter.Format Specified parameter format is not valid. 返回值格式不正确(Format 不支持)。返回格式支持 XML 与 JSON,默认为 XML。
400 MissingParameter The input parameter %s that is mandatory for processing this request is not supplied. 参数缺失。
500 InternalError The request processing has failed due to some unknown error, exception or failure. 内部错误。
403 Forbidden User is not authorized to operate. 当前用户无权限对当前资源执行任何操作。请检查您的账号权限或者咨询您的主账号管理员。
403 Forbidden.Action User is not authorized to operate this action. 当前用户无权限执行该操作。请检查您的账号权限或者咨询您的主账号管理员。
403 InvalidAccountStatus.NotEnoughBalance Your account does not have enough balance. 您的账户余额不足。
403 LastTokenProcessing The last token request is processing. 相同clientToken的请求正在执行,请稍后再重试。
403 NoPermission.SLR The RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS. 当前用户无权限创建SLR。
403 OperationDenied The operation is not allowed. 当前操作不允许执行。
404 InvalidApi.NotFound Specified api is not found, please check your url and method.
404 NoSuchResource The specified resource does not exist. 指定的资源不存在。
504 RequestTimeout The request is timeout, please try again later. 该请求超时,请稍后再重试。
429 BLOCK.LimitedRequest Request was denied due to user flow control.

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

变更历史

更多信息,参考变更详情