Creating an Instance Diagnosis Task

Updated on 2022-09-19 GMT+08:00

View PDF

Function

This API is used to diagnose a specific DCS instance.

URI

POST /v2/{project_id}/instances/{instance_id}/diagnosis

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
instance_id	Yes	String	Instance ID.
project_id	Yes	String	Project ID.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
begin_time	Yes	String	Diagnosis start time, The time is a Unix timestamp and the unit is ms.
end_time	Yes	String	Diagnosis end time, The time is a Unix timestamp and the unit is ms.
node_ip_list	No	Array of strings	IP addresses of diagnosed nodes. By default, all nodes are diagnosed. Query methods for an instance: Method 1: See Viewing Instance Details. Method 2: Call the API for Querying a DCS instance.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
report_id	String	Report ID.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_msg	String	Error message. Maximum: 1024
error_code	String	Error code. Maximum: 9
error_ext_msg	String	Extended error information. This parameter is not used currently and is set to null. Maximum: 1024

Status code: 500

**Table 5** Response body parameters
Parameter	Type	Description
error_msg	String	Error message. Maximum: 1024
error_code	String	Error code. Maximum: 9
error_ext_msg	String	Extended error information. This parameter is not used currently and is set to null. Maximum: 1024

Example Requests

POST https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/diagnosis

{
  "begin_time" : 1618466522486,
  "end_time" : 1618467122486,
  "node_ip_list" : [ "192.168.0.111" ]
}

Example Responses

Status code: 200

The diagnosis task is successfully delivered.

{
  "report_id" : "716c9cca-8ce2-4a89-b3db-7cee209d6379"
}

Status Codes

Status Code	Description
200	The diagnosis task is successfully delivered.
400	Invalid request.
500	Internal service error.

Error Codes

See Error Codes.

Parent topic: Instance Diagnosis

Previous topic: Instance Diagnosis

Next topic: Listing Instance Diagnosis Tasks

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel