Queries diagnostic reports.

Database Autonomy Service (DAS) regularly inspects all the database instances that are connected to DAS and generates health scores. This way, the running status of databases is visualized.

Before you call this operation, make sure that the following requirements are met:

  • If you use an Alibaba Cloud SDK, make sure that the aliyun-sdk-core version is later than V4.3.3. We recommend that you use the latest version.
  • The version of DAS SDK must be V1.0.3 or later.
  • If you use an SDK to call the DAS service, you must set the region to cn-shanghai.
  • This operation can be used in the following database services:
    • ApsaraDB RDS for MySQL
    • PolarDB for MySQL
    • ApsaraDB for Redis
    • ApsaraDB for MongoDB

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDiagnosticReportList

The operation that you want to perform. Set the value to DescribeDiagnosticReportList.

DBInstanceId String Yes rm-2ze8g2am97624****

The ID of the instance.

PageNo String No 1

The number of the page to return. The value must be an integer that is greater than 0. Default value: 1.

PageSize String No 10

The maximum number of entries to return on each page. Default value: 10.

StartTime String Yes 1648605944000

The beginning of the time range to query. Specify the time in the UNIX timestamp format. The time must be in UTC. Unit: milliseconds.

EndTime String Yes 1648608644000

The end of the time range to query. Specify the time in the UNIX timestamp format. Unit: milliseconds.

Note The end time must be later than the start time.

Response parameters

Parameter Type Example Description
RequestId String ac544623-f6ad-45fd-9a74-9be3db65****

The ID of the request.

Message String Successful

The message that is returned for the request.

Note If the request is successful, Successful is returned. If the request fails, an error message that contains information such as an error code is returned.
Synchro String None

A reserved parameter.

Data String null

The information of diagnostic reports. Valid values:

  • total: the number of diagnostic reports.
  • score: the health score.
  • diagnosticTime: the time when the diagnostic report is generated. The time is displayed in UTC
  • startTime: the start time of the query. The time is displayed in UTC.
  • endTime: the end time of the query. The time is displayed in UTC.
Code String 200

The returned HTTP status code.

Success String true

Indicates whether the request is successful. Valid values:

  • true
  • false

Examples

Sample requests

http(s)://das.cn-shanghai.aliyuncs.com/?Action=DescribeDiagnosticReportList
&DBInstanceId=rm-2ze8g2am97624****
&PageNo=1
&PageSize=10
&StartTime=1648605944000
&EndTime=1648608644000
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDiagnosticReportListResponse>
    <RequestId>ac544623-f6ad-45fd-9a74-9be3db65****</RequestId>
    <Message>Successful</Message>
    <Synchro>None</Synchro>
    <Data>{     "total": 1,     "list": [       {         "score": 100,         "diagnosticTime": "2022-03-30T02:35:34Z",         "startTime": "2022-03-30T02:05:44Z",         "endTime": "2022-03-30T02:20:44Z"       }     ]   }</Data>
    <Code>200</Code>
    <Success>true</Success>
</DescribeDiagnosticReportListResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "ac544623-f6ad-45fd-9a74-9be3db65****",
  "Message" : "Successful",
  "Synchro" : "None",
  "Data" : "{     \"total\": 1,     \"list\": [       {         \"score\": 100,         \"diagnosticTime\": \"2022-03-30T02:35:34Z\",         \"startTime\": \"2022-03-30T02:05:44Z\",         \"endTime\": \"2022-03-30T02:20:44Z\"       }     ]   }",
  "Code" : 200,
  "Success" : true
}

Error codes

HTTP status code Error code Error message Description
400 InvalidParams The request parameters are invalid. The error message returned because the specified request parameters are invalid.

For a list of error codes, visit the API Error Center.