Obtaining a Remote Login Address (Discarded)

Function

This API is used to obtain the address for remotely logging in to a BMS.

This API has been discarded. Use the API in Obtaining the Address for Remotely Logging In to a BMS.

URL

POST /v2.1/{project_id}/servers/{server_id}/action

Table 1 lists the parameters.

**Table 1** Parameter description
Parameter	Mandatory	Description
project_id	Yes	Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
server_id	Yes	Specifies the BMS ID. You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Discarded).

Request Message

Request parameters

Parameter	Mandatory	Type	Description
os-getSerialConsole	Yes	Object	Specifies the action to obtain the BMS remote login address. For details, see Table 2.

**Table 2** **os-getSerialConsole** field data structure description
Parameter	Mandatory	Type	Description
type	Yes	String	Specifies the object. Set the value to serial.

Example request

Obtaining the remote login address of a BMS (ID: 47e9be4e-a7b9-471f-92d9-ffc83814e07a)

       
            POST https://{ECS Endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/servers/47e9be4e-a7b9-471f-92d9-ffc83814e07a/action

       
            {
    "os-getSerialConsole": {
        "type": "serial"
    }
}

Response Message

Response parameters
None

Example response

      
           {
    "console": {
        "url": "https://baremetal-consoleproxy.az1.dc1.domainname.com:8003/?token=040134bb-9195-4029-9a62-550bce390258",
        type": "serial"
    }
}