• Bare Metal Server

bms
  1. Help Center
  2. Bare Metal Server
  3. API Reference
  4. API
  5. BMS IP Address Query (Native OpenStack APIs)
  6. Querying IP Addresses of BMSs (Native OpenStack API)

Querying IP Addresses of BMSs (Native OpenStack API)

Function

This interface is used to query the IP address of a BMS.

Constraints

Pagination query is not supported.

URI

GET /v2.1/{project_id}/servers/{server_id}/ips

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.

Request Message

N/A

Response Message

  • Response parameters

    Parameter

    Type

    Description

    addresses

    Dict

    Specifies the BMS network information. For details, see [1] addresses parameter structure description.

    [1] addresses parameter structure description

    Parameter

    Type

    Description

    BMS network name

    List <Dict>

    Specifies the network used by the BMS. For details about the network information, see [2] Network parameter structure description.

    [2] Network parameter structure description

    Parameter

    Type

    Description

    version

    Int

    Specifies the IP address version. The value can be IPv4 or IPv6.

    addr

    String

    Specifies the IP address.

  • Example response
    {
        "addresses": {
            "08a7715f-7de6-4ff9-a343-95ba4209f24a": [
                {
                    "version": 4,
                    "addr": "192.168.2.90"
                }
            ]
        }
    }

Returned Values

See section Common Returned Values.