Creating an Instance Diagnosis Task

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
project_id	Yes	String	Definition Project ID. For details, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
instance_id	Yes	String	Definition Instance ID. It can be viewed on the instance details page on the DCS console. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
begin_time	Yes	String	Definition Diagnosis start time. The value is a UNIX timestamp, in milliseconds. Constraints N/A Range N/A Default Value N/A
end_time	Yes	String	Definition Diagnosis end time. The value is a UNIX timestamp, in milliseconds. Constraints N/A Range N/A Default Value N/A
node_ip_list	No	Array of strings	Definition IP addresses of diagnosed nodes. By default, all nodes are diagnosed. Query methods for an instance that is not the read/write splitting type.: Method 1: See "Viewing Instance Details" in the DCS User Guide. Method 2: Call the API for Querying Details About a Specified Instance. For read/write splitting instances, call the API used to query shard information. Constraints N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
report_id	String	Definition Report ID. Range N/A

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_msg	String	Definition Error information. Range N/A
error_code	String	Definition Error code. Range For details, see Error Codes.
error_ext_msg	String	Definition Extended error information. This parameter is not used currently and is set to null. Range N/A

Status code: 500

**Table 5** Response body parameters
Parameter	Type	Description
error_msg	String	Definition Error information. Range N/A
error_code	String	Definition Error code. Range For details, see Error Codes.
error_ext_msg	String	Definition Extended error information. This parameter is not used currently and is set to null. Range N/A

Example Requests

Creating an instance diagnosis task and setting the diagnosis start time and end time and the IP address of the node to be diagnosed

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.See the reply and handling status in My Cloud VOC.

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

For any further questions, feel free to contact us through the chatbot.

Chatbot