Query diagnostic reports using DescribeDiagnosticReportList - Database Autonomy Service

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hdm:DescribeDiagnosticReportList

get

*All Resource

*

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 elements

Element	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

Success response

JSON format

{
  "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	Description
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.