Changing the Name of a BMS (Deprecated)_BMS Status Management (OpenStack Nova APIs)_Historical APIs_API Reference

Function

This API is used to modify BMS information. Currently, only the name of a BMS can be changed.

This API has been deprecated. Use the API in Changing a BMS Name.

URI

PUT /v2.1/{project_id}/servers/{server_id}

Table 1 lists the parameters.

**Table 1** Parameter description
Parameter	Mandatory	Description
project_id	Yes	Specifies the project ID.
server_id	Yes	Specifies the BMS ID. You can obtain the BMS ID from the BMS console or by calling the API Querying BMSs (Deprecated).

Request Parameters

Parameter	Mandatory	Type	Description
server	Yes	Object	Specifies the BMS data structure. For details, see Table 2.

**Table 2** **server** data structure
Parameter	Mandatory	Type	Description
name	Yes	String	Specifies the new BMS name.

Example Request

Changing the name of a BMS (ID: 95bf2490-5428-432c-ad9b-5e3406f869dd) to new-server-test

     PUT https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd

     {
    "server": {
        "name": "new-server-test"
    }
}
 
 
  

Response Parameters

**Table 3** Response parameters
Parameter	Type	Description
server	Object	Specifies BMS information. For details, see Table 4.

**Table 4** **server** data structure
Parameter	Type	Description
name	String	Specifies the BMS name.
id	String	Specifies the unique ID of the BMS.
status	String	Specifies the BMS status. ACTIVE: Running, Stopping, Deleting BUILD: Creating ERROR: Faulty HARD_REBOOT: Forcibly Restarting REBOOT: Restarting SHUTOFF: Stopped, Starting, Deleting, Rebuilding, Reinstalling OS, OS Reinstallation Failed, Frozen
created	String	Specifies the time when the BMS was created. The timestamp format is YYYY-MM-DDTHH:MM:SSZ (ISO 8601), for example, 2019-05-22T03:30:52Z.
updated	String	Specifies the last time when the BMS was updated. The timestamp format is YYYY-MM-DDTHH:MM:SSZ (ISO 8601), for example, 2019-05-22T04:30:52Z.
flavor	Object	Specifies the BMS flavor. For details, see Table 5.
image	Object	Specifies the BMS image. For details, see Table 6.
tenant_id	String	Specifies the ID of the tenant owning the BMS. The value is in UUID format. This parameter specifies the same meaning as project_id.
user_id	String	Specifies the ID of the user owning the BMS.
metadata	Object	Specifies the BMS metadata. For details, see Table 7.
hostId	String	Specifies the host ID of the BMS.
addresses	Array of address objects	Specifies the VPC used by the BMS. key: indicates the ID of the VPC used by the BMS. value: indicates the VPC details. For details, see Table 9.
links	Array of objects	Specifies shortcut links of the BMS. For details, see Table 8.
accessIPv4	String	This is a reserved attribute.
accessIPv6	String	This is a reserved attribute.
OS-DCF:diskConfig	String	Specifies the disk configuration method. This is an extended attribute. The value can be: MANUAL: The BMS is created using the partitioning scheme and file system in the image. If the target flavor has a large disk, the remaining disk space cannot be partitioned. AUTO: The BMS is created using a single partition with the same size as the disk of the target flavor. The file system can automatically adapt to the entire partition.
progress	Integer	This is a reserved attribute.

**Table 5** **flavor** data structure
Parameter	Type	Description
id	String	Specifies the flavor ID.
links	Array of objects	Specifies the shortcut link of the BMS flavor. For details, see Table 8.

**Table 6** **image** data structure
Parameter	Type	Description
id	String	Specifies the image ID of the BMS.
links	Array of objects	Specifies shortcut links of the BMS image. For details, see Table 8.

**Table 7** **metadata** data structure
Parameter	Type	Description
User-defined field key and value pair	String	Specifies the key and value pair of the metadata. Each key or value contains a maximum of 255 characters.

**Table 8** **links** data structure
Parameter	Type	Description
rel	String	Specifies the shortcut link marker name. The value can be: self: resource link that contains the version number. It is used when immediate tracing is required. bookmark: resource link that can be stored for a long time.
href	String	Specifies the corresponding shortcut link.

**Table 9** **address** data structure
Parameter	Type	Description
addr	String	Specifies the IP address.
version	String	Specifies the version of the IP address.

Example Response

     {
    "server": {
        "tenant_id": "c685484a8cc2416b97260938705deb65",
        "image": {
            "links": [
                {
                    "rel": "bookmark",
                    "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/images/1a6635d8-afea-4f2b-abb6-27a202bad319"
                }
            ],
            "id": "1a6635d8-afea-4f2b-abb6-27a202bad319"
        },
        "accessIPv4": "",
        "addresses": {
            "08a7715f-7de6-4ff9-a343-95ba4209f24a": [
                {
                    "addr": "192.168.0.107",
                    "version": 4
                }
            ]
        },
        "metadata": {
        },
        "accessIPv6": "",
        "created": "2017-05-24T06:14:05Z",
        "hostId": "e9c3ee0fcc58ab6085cf30df70b5544eab958858fb50d925f023e53e",
        "flavor": {
            "links": [
                {
                    "rel": "bookmark",
                    "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/flavors/physical.83.medium"
                }
            ],
            "id": "physical.83.medium"
        },
        "OS-DCF:diskConfig": "MANUAL",
        "user_id": "1311c433dd9b408886f57d695c229cbe",
        "name": "new-server-test",
        "progress": 0,
        "links": [
            {
                "rel": "self",
                "href": "https://openstack.example.com/v2/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd"
            },
            {
                "rel": "bookmark",
                "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd"
            }
        ],
        "id": "95bf2490-5428-432c-ad9b-5e3406f869dd",
        "updated": "2017-05-25T03:40:25Z",
        "status": "ACTIVE"
    }
}
 
 
  

Returned Values

Normal values

Returned Values	Description
200	The request has been successfully processed.

For details about other returned values, see Status Codes.

Error Codes

See Error Codes.

Changing the Name of a BMS (Deprecated)