Help Center/ Data Admin Service/ API Reference/ APIs (in OBT)/ Intelligent O&M/ Creating an Instance Diagnosis Task
Updated on 2025-05-19 GMT+08:00

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

Explanation:

Project ID of a tenant in a region

To obtain this value, see Obtaining a Project ID.

Constraints:

N/A

Values:

The value can contain 32 characters. Only letters and digits are allowed.

Default value:

N/A

instance_id

Yes

String

Explanation:

Unique ID of an instance

Constraints:

N/A

Values:

The value can contain 32 characters. Only letters and digits are allowed.

Default value:

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

start_at

Yes

Long

Explanation:

Start time in the Unix timestamp format, in milliseconds

Constraints:

N/A

Values:

[0, 2^31-1]. The actual value depends on the query result.

Default value:

N/A

end_at

Yes

Long

Explanation:

End time in the Unix timestamp format, in milliseconds

Constraints:

N/A

Values:

[0, 2^31-1]. The actual value depends on the query result.

Default value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

create_success

Boolean

Explanation:

Whether the diagnosis task is successfully created

Values:

N/A

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

Successful request

{ 
  "create_success" : true 
}

Status Codes

Status Code

Description

200

Successful request

400

Client error

500

Server error

Error Codes

See Error Codes.