文档

DescribeDiagnosticReportList - 查询诊断报告

更新时间:

调用DescribeDiagnosticReportList接口,查询诊断报告。

接口说明

使用该接口需满足以下前提条件:

  • 使用阿里云或 DAS 的 SDK 时,建议使用最新版本。

  • 在调用 DAS 服务时,需要将地域指定为 cn-shanghai。

  • 本接口适用的数据库引擎为:

    • RDS MySQL
    • PolarDB MySQL 版
    • Redis

调试

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

授权信息

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

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

请求参数

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

实例 ID。

rm-2ze8g2am97624****
PageNostring

页码,取值大于 0 且不超过 Integer 数据类型的最大值,默认值为 1。

1
PageSizestring

每页最大记录数,默认值为 10。

10
StartTimestring

查询任务开始时间,格式为 Unix 时间戳(UTC 时间),单位为毫秒。

1668398892000
EndTimestring

查询任务结束时间,格式为 Unix 时间戳,单位为毫秒。

说明 查询任务结束时间需晚于查询任务开始时间。
1668420492000

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

D00DB161-FEF6-5428-B37A-8D29A4C2****
Messagestring

请求返回消息。

说明 请求成功时该参数返回 Successful,请求失败时会返回请求异常信息(如错误码等)。
Successful
Synchrostring

备用参数。

None
Datastring

返回的数据:

  • total:数据量。
  • score:诊断分数。
  • diagnosticTime:诊断生成时间(UTC 时间)。
  • startTime:查询开始时间(UTC 时间)。
  • endTime:查询结束时间(UTC 时间)。
{ "total": 1, "list": [ { "score": 100, "diagnosticTime": "2022-11-14T08:17:00Z", "startTime": "2022-11-14T07:16:59Z", "endTime": "2022-11-14T08:16:59Z" } ] }
Codestring

返回的状态码。

200
Successstring

请求是否执行成功:

  • true:执行成功。
  • false:执行失败。
true

示例

正常返回示例

JSON格式

{
  "RequestId": "D00DB161-FEF6-5428-B37A-8D29A4C2****",
  "Message": "Successful",
  "Synchro": "None",
  "Data": "{     \"total\": 1,     \"list\": [       {         \"score\": 100,         \"diagnosticTime\": \"2022-11-14T08:17:00Z\",         \"startTime\": \"2022-11-14T07:16:59Z\",         \"endTime\": \"2022-11-14T08:16:59Z\"       }     ]   }",
  "Code": "200",
  "Success": "true"
}

错误码

HTTP status code错误码错误信息描述
400InvalidParamsThe request parameters are invalid.请求参数错误
403NoPermissionYou are not authorized to do this action.没有权限执行该操作

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)