Creates a diagnostic report.

Database Autonomy Service (DAS) regularly inspects all the database instances that are connected to DAS and then generates health scores. This way, the status of your databases is clear at a glance.

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

  • This operation is applicable only to ApsaraDB for Redis Community Edition and ApsaraDB for Redis Enhanced Edition (Tair).
  • When 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.
  • When you call this operation to use DAS, you must specify cn-shanghai as the region.

Request parameters

Parameter Type Required Example Description
Action String No CreateDiagnosticReport

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

Uid String No hdm_df02bbfd3bd64c7bb1982e5323a6****

The ID of the logon account. On the Security Settings page in the Alibaba Cloud account management center, you can obtain the ID of the logon account.

accessKey String No None

A hidden parameter.

signature String No None

A hidden parameter.

timestamp String No None

A hidden parameter.

__context String No None

A hidden parameter.

skipAuth String No None

A hidden parameter.

UserId String No None

A hidden parameter.

DBInstanceId String No r-s****

The ID of the instance.

StartTime String No 1596177993000

The start time of the task for creating the diagnostic report. Specify the time in the UNIX timestamp format. The time must be in UTC. Unit: milliseconds.

EndTime String No 1596177993001

The end time of the task for creating the diagnostic report. Specify the time in the UNIX timestamp format. The time must be in UTC. 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 returned for the request.

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

A hidden parameter.

Data String { "cpuUsage": 0.00029999999999999894, "maxConnection": 32532, "slowSqlCount": 0, "exceptionTableMap": { "table_space": 1, "table_row": 1 },

The returned data.

Code String 200

The returned status code.

Success String true

Indicates whether the request is successful. Valid values:

  • true: The request is successful.
  • false: The request failed.

Examples

Sample requests

http(s)://das.cn-shanghai.aliyuncs.com/?Action=CreateDiagnosticReport
&Uid=hdm_df02bbfd3bd64c7bb1982e5323a6****
&accessKey=None
&signature=None
&timestamp=None
&__context=None
&skipAuth=None
&UserId=None
&DBInstanceId=r-s****
&StartTime=1596177993000
&EndTime=1596177993001
&<Common request parameters>

Sample success responses

XML format

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

<CreateDiagnosticReportResponse>
    <RequestId>ac544623-f6ad-45fd-9a74-9be3db65****</RequestId>
    <Message>Successful</Message>
    <Synchro>None</Synchro>
    <Data>{ "cpuUsage": 0.00029999999999999894, "maxConnection": 32532, "slowSqlCount": 0, "exceptionTableMap": { "table_space": 1, "table_row": 1 },</Data>
    <Code>200</Code>
    <Success>true</Success>
</CreateDiagnosticReportResponse>

JSON format

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

{
  "RequestId" : "ac544623-f6ad-45fd-9a74-9be3db65****",
  "Message" : "Successful",
  "Synchro" : "None",
  "Data" : "{ \"cpuUsage\": 0.00029999999999999894, \"maxConnection\": 32532, \"slowSqlCount\": 0, \"exceptionTableMap\": { \"table_space\": 1, \"table_row\": 1 },",
  "Code" : "200",
  "Success" : "true"
}

Error codes

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