Obtaining the Serial Port Login Address

This API is used to obtain the serial port login address of an ECS.

This API is only supported in the following regions: AF-Cairo, AF-Johannesburg, and ME-Riyadh.

You can debug this API in API Explorer.

POST /v1/{project_id}/cloudservers/{server_id}/actions/serial-console

Table 1 describes the parameters in the URI.

**Table 1** Parameter description
Parameter	Mandatory	Description
project_id	Yes	Definition Specifies the project ID. For details about how to obtain the ID, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
server_id	Yes	Definition Specifies the ECS ID. Constraints N/A Range N/A Default Value N/A

None.

Table 2 describes the response parameter.

**Table 2** Response parameters
Parameter	Type	Description
serial_console	Object	Definition Specifies the serial port login address. For details, see Table 3. Range N/A

**Table 3** **serial_console** parameter description
Parameter	Type	Description
url	String	Definition Specifies the URL for serial port login. Range N/A

POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/actions/serial-console

{ 
     "serial_console": { 
             "url": "xxxx", 
         } 
 }

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.

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