DescribeDiagnosticReportList - Database Autonomy Service

Queries diagnostics reports.

Operation description

Before you call this operation, take note of the following items:

If you use an Alibaba Cloud SDK or a Database Autonomy Service (DAS) SDK to call this operation, we recommend that you use the latest version of the SDK.
If you use an SDK to call operations of DAS, you must set the region ID to cn-shanghai.
This operation is applicable to the following database engines:
- ApsaraDB RDS for MySQL
- PolarDB for MySQL
- ApsaraDB for Redis

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
hdm:DescribeDiagnosticReportList	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID.	rm-2ze8g2am97624****
PageNo	string	No	The page number. The value must be a positive integer. Default value: 1.	1
PageSize	string	No	The number of entries per page. Default value: 10.	10
StartTime	string	Yes	The beginning of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1668398892000
EndTime	string	Yes	The end of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. Note The end time must be later than the start time.	1668420492000

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	D00DB161-FEF6-5428-B37A-8D29A4C2****
Message	string	The returned message. Note If the request was successful, Successful is returned. If the request failed, an error message such as an error code is returned.	Successful
Synchro	string	The reserved parameter.	None
Data	string	The information of the diagnostics reports. Valid values: total: the number of diagnostics reports. score: the health score. diagnosticTime: the time when the diagnostics report was 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.	{ "total": 1, "list": [ { "score": 100, "diagnosticTime": "2022-11-14T08:17:00Z", "startTime": "2022-11-14T07:16:59Z", "endTime": "2022-11-14T08:16:59Z" } ] }
Code	string	The HTTP status code returned.	200
Success	string	Indicates whether the request was successful. Valid values: true false	true

Examples

Sample success responses

JSONformat

{
  "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"
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history