Help Center/ Data Admin Service/ API Reference/ APIs (in OBT)/ Cloud DBA/ Creating an Instance Diagnosis Task
Updated on 2024-12-04 GMT+08:00
View PDF
Share

Creating an Instance Diagnosis Task

Function

This API is used to create an instance diagnosis task.

URI

POST /v3/{project_id}/instances/{instance_id}/create-instance-health-report-task

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

To obtain the value, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

X-Language

No

String

Language

Enumerated values:

  • zh-cn
  • en-us
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

start_at

Yes

Long

Start time in Unix timestamp format, in milliseconds

end_at

Yes

Long

End time in Unix timestamp format, in milliseconds

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

create_success

Boolean

Whether the diagnosis task is successfully created

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Example Request

Creating an instance diagnosis task

POST https://das.cn-north-7.myhuaweicloud.com/v3/052041494800d57c2f02c00275b4c247/instances/bcfa975193f1402fa11a6d4fd6baf5fbin01/create-instance-health-report-task 

{ 
  "start_at" : 1728103093329, 
  "end_at" : 1729103093329 
}

Example Response

Status code: 200

Success

{ 
  "create_success" : true 
}

Status Codes

Status Code

Description

200

Success

400

Client error

500

Server error

Error Codes

See Error Codes.

Parent topic: Cloud DBA