Help Center> Bare Metal Server> API Reference> Native OpenStack Nova V2.1 APIs> BMS Lifecycle Management> Querying Details About a BMS (Native OpenStack API)
Updated on 2024-02-07 GMT+08:00
View PDF

Querying Details About a BMS (Native OpenStack API)

Function

This API is used to query details about a BMS based on the BMS ID.

URI

GET /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.

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 (Native OpenStack API).

Request Parameters

None

Example Request

Querying details about a BMS (ID: 9ab74d89-61e7-4259-8546-465fdebe4944) 
1
 
GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/9ab74d89-61e7-4259-8546-465fdebe4944

Response Parameters

Parameter

Type

Description

server

Object

Specifies BMS information. For details, see Table 2.
Table 2 server field data structure description

Parameter

Type

Description

name

String

Specifies the BMS name.

id

String

Specifies the unique ID of the BMS.

status

String

Specifies the BMS status.

Value range:

  • 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 time when the BMS was last 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 3.

image

Object

Specifies the BMS image. For details, see Table 4.

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.

key_name

String

Specifies the SSH key name.

user_id

String

Specifies the ID of the user to which the BMS belongs.

metadata

Map<String,String>

Specifies the BMS metadata.

It is a user-defined metadata key-value pair. Each key or value contains a maximum of 255 characters.

hostId

String

Specifies the host ID of the BMS.

addresses

Map<String,Array of address objects>

Specifies BMS network addresses. Specifies the VPC used by the BMS.

  • key: indicates the ID of the VPC used by the BMS.
  • value indicates the VPC details.

security_groups

Array of objects

Specifies the security groups to which the BMS belongs. For details, see Table 7.

links

Array of objects

Specifies shortcut links of the BMS. For details, see Table 5.

OS-DCF:diskConfig

String

Specifies the disk configuration method. This is an extended attribute. The value can be:

  • MANUAL: The API uses the partitioning scheme in the image and the file system to create a BMS. If the target flavor has a large disk, the API does not partition the remaining disk space.
  • AUTO: The API uses a single partition with the same size as the disk of the target flavor to create a BMS. The API automatically adjusts the file system to adapt to the entire partition.

OS-EXT-AZ:availability_zone

String

Specifies the AZ where the BMS is located.

OS-EXT-SRV-ATTR:host

String

Specifies the hostname of the BMS. This is an extended attribute.

OS-EXT-SRV-ATTR:hypervisor_hostname

String

Specifies the hostname of the hypervisor. This is an extended attribute provided by the Nova virt driver.

OS-EXT-SRV-ATTR:instance_name

String

Specifies the BMS alias. This is an extended attribute.

OS-EXT-STS:power_state

Integer

Specifies the BMS power status. This is an extended attribute.

Options: 0, 1, 2, 3, and 4

  • 0: pending
  • 1: running
  • 2: paused
  • 3: shutdown
  • 4: crashed

OS-EXT-STS:task_state

String

Specifies the BMS task status. This is an extended attribute.

Value range:

  • rebooting: The BMS is being restarted.
  • reboot_started: The BMS is normally restarted.
  • reboot_started_hard: The BMS is forcibly restarted.
  • powering-off: The BMS is being powered off.
  • powering-on: The BMS is being powered on.
  • rebuilding: The BMS is being rebuilt.
  • scheduling: The BMS is being scheduled.
  • deleting: The BMS is being deleted.

OS-EXT-STS:vm_state

String

Specifies the BMS status. This is an extended attribute.

Value range:

  • active: The BMS is running.
  • stopped: The BMS is stopped.

OS-SRV-USG:launched_at

String

Specifies the time when the BMS was started. This is an extended attribute.

The timestamp format is ISO 8601, for example, 2019-05-22T03:23:59.000000.

OS-SRV-USG:terminated_at

String

Specifies the time when the BMS was deleted. This is an extended attribute.

The timestamp format is ISO 8601, for example, 2019-05-22T04:23:59.000000.

os-extended-volumes:volumes_attached

Array of objects

Specifies the EVS disks attached to the BMS. For details, see Table 8.

accessIPv4

String

This is a reserved attribute.

accessIPv6

String

This is a reserved attribute.

fault

Object

Specifies the fault cause. If the BMS is faulty, this field is returned. For details, see Table 9.

config_drive

String

This is a reserved attribute.

progress

Integer

This is a reserved attribute.

description

String

Provides supplementary information about the pool.

This parameter is added in micro version 2.19.

host_status

String

Specifies the status of the host that accommodates the BMS.

  • UP: The nova-compute is normal.
  • UNKNOWN: The nova-compute status is unknown.
  • DOWN: the nova-compute status is abnormal.
  • MAINTENANCE: The nova-compute is in the maintenance state.
  • Empty string: The BMS does not have host information.

Added in micro version 2.16.

OS-EXT-SRV-ATTR:hostname

String

Specifies the hostname of the BMS.

Added in micro version 2.3.

OS-EXT-SRV-ATTR:reservation_id

String

Specifies the reserved BMS IDs in a batch BMS creation situation.

Added in micro version 2.3.

OS-EXT-SRV-ATTR:launch_index

Integer

Specifies the BMS startup sequence in a batch BMS creation situation.

Added in micro version 2.3.

OS-EXT-SRV-ATTR:kernel_id

String

Specifies the UUID of the kernel image when the AMI image is used. In other scenarios, leave this parameter blank.

Added in micro version 2.3.

OS-EXT-SRV-ATTR:ramdisk_id

String

Specifies the UUID of the Ramdisk image when the AMI image is used. In other scenarios, leave this parameter blank.

Added in micro version 2.3.

OS-EXT-SRV-ATTR:root_device_name

String

Specifies the device name of the BMS system disk, for example, /dev/sda.

Added in micro version 2.3.

OS-EXT-SRV-ATTR:user_data

String

Specifies the user_data specified during BMS creation. The value is encoded using Base64 or an empty string.

locked

Boolean

Specifies whether the BMS is locked.

  • true: The BMS is locked.
  • false: The BMS is not locked.

Added in micro version 2.9.

tags

Array of strings

Specifies tags of the BMS.

This parameter is added in microversion 2.26. If the microversion is not used for query, the response does not contain the tags field.

The value of this field meets the following requirements:

  • The key and value of a tag are connected using an equal sign (=), for example, key=value.
  • If the value is empty, only the key is returned.
Table 3 flavor field data structure description

Parameter

Type

Description

id

String

Specifies the BMS type ID.

links

Array of objects

Specifies shortcut links of the BMS type.

For details, see Table 5.
Table 4 image field data structure description

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 5.
Table 5 links field data structure description

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 6 address field data structure description

Parameter

Type

Description

addr

String

Specifies the IP address.

version

Integer

Specifies the type of the IP address. The value can be 4 or 6.

  • 4: The type of the IP address is IPv4.
  • 6: The type of the IP address is IPv6.

OS-EXT-IPS-MAC:mac_addr

String

Specifies the MAC address. This is an extended attribute.

OS-EXT-IPS:type

String

Specifies the IP address type. This is an extended attribute.

  • fixed: indicates the private IP address.
  • floating: indicates the EIP.
Table 7 security_groups field data structure description

Parameter

Type

Description

name

String
  • If no security group is specified during BMS creation, the default value is used.
  • If a security group is specified when you create the BMS, the value of this parameter is the security group name.
Table 8 os-extended-volumes:volumes_attached field data structure description

Parameter

Type

Description

id

String

Specifies the EVS disk ID.

delete_on_termination

Boolean

Specifies whether to delete the disk when deleting the BMS.

  • true: Yes
  • false: No

Added in micro version 2.3.
Table 9 fault field data structure description

Parameter

Type

Description

message

String

Specifies the fault information.

code

Integer

Specifies the fault code.

details

String

Specifies the fault details.

created

String

Specifies the time when the fault occurred. The time is in ISO 8601 format.

Example Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
{
    "server": {
        "tenant_id": "c685484a8cc2416b97260938705deb65",
        "addresses": {
            "08a7715f-7de6-4ff9-a343-95ba4209f24a": [
{
                    "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:0e:c3:77",
                    "OS-EXT-IPS:type": "fixed",
                    "addr": "192.168.0.107",
                    "version": 4
                }
            ]
        },
        "metadata": {
            "op_svc_userid": "1311c433dd9b408886f57d695c229cbe"
        },
        "OS-EXT-STS:task_state": null,
        "OS-DCF:diskConfig": "MANUAL",
        "OS-EXT-AZ:availability_zone": "az-dc-1",
        "links": [
{
                "rel": "self",
                "href": "https://openstack.example.com/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd"
            },
{
                "rel": "bookmark",
                "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd"
                }
        ],
        "OS-EXT-STS:power_state": 1,
        "id": "95bf2490-5428-432c-ad9b-5e3406f869dd",
        "os-extended-volumes:volumes_attached": [
{
                "id": "dfa375b5-9856-44ad-a937-a4802b6434c3"
            },
{
                "id": "bb9f1b27-843b-4561-b62e-ca18eeaec417"
            },
{
                "id": "86e801c3-acc6-465d-890c-d43ba493f553"
            },
{
                "id": "0994d3ac-3c6a-495c-a439-c597a4f08fa6"
                }
        ],
        "OS-EXT-SRV-ATTR:host": "bms.az1",
        "image": {
            "links": [
{
                    "rel": "bookmark",
                    "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/images/1a6635d8-afea-4f2b-abb6-27a202bad319"
                }
            ],
            "id": "1a6635d8-afea-4f2b-abb6-27a202bad319"
        },
        "OS-SRV-USG:terminated_at": null,
        "accessIPv4": "",
        "accessIPv6": "",
        "created": "2017-05-24T06:14:05Z",
        "hostId": "e9c3ee0fcc58ab6085cf30df70b5544eab958858fb50d925f023e53e",
        "OS-EXT-SRV-ATTR:hypervisor_hostname": "nova004@2",
        "key_name": "$key_name",
        "flavor": {
            "links": [
{
                    "rel": "bookmark",
                    "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/flavors/physical.83.medium"
                }
            ],
            "id": "physical.83.medium"
        },
        "security_groups": [
{
                "name": "0011b620-4982-42e4-ad12-47c95ca495c4"
                }
        ],
        "config_drive": "",
        "OS-EXT-STS:vm_state": "active",
        "OS-EXT-SRV-ATTR:instance_name": "instance-0000ebd3",
        "user_id": "1311c433dd9b408886f57d695c229cbe",
        "name": "bms-83",
        "progress": 0,
        "OS-SRV-USG:launched_at": "2017-05-25T03:40:25.066078",
        "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.

Parent topic: BMS Lifecycle Management