Help Center> Bare Metal Server> API Reference> Native OpenStack Nova V2.1 APIs> BMS IP Address Query> Querying IP Addresses of a BMS (Native OpenStack API)
View PDF

Querying IP Addresses of a BMS (Native OpenStack API)

Function

This API is used to query private IP addresses 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.

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 using the Querying BMSs (Native OpenStack API) API.

Request Message

  • Request parameters

    None

  • Example request 
    1
    		 
    GET https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/ips

Response Message

  • Response parameters

    Parameter

    Type

    Description

    addresses

    Object

    Specifies IP addresses of the BMS. For details, see Table 2.
    Table 2 addresses parameter structure description

    Parameter

    Type

    Description

    vpc_id

    Array of 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 3.
    Table 3 address parameter structure description

    Parameter

    Type

    Description

    version

    Integer

    Specifies the IP address version. The value can be:

    • 4: IPv4 address
    • 6: IPv6 address

    addr

    String

    Specifies the IP address.
  • Example response 
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
    		 
    {
    "addresses": {
        "08a7715f-7de6-4ff9-a343-95ba4209f24a": [
            {
                "version": 4,
                "addr": "192.168.2.90"
            }
        ]
    }
}

Returned Values

Normal values

Returned Values

Description

200

The server has successfully processed the request.

For details about other returned values, see Status Codes.

Error Codes

See Error Codes.

Parent topic: BMS IP Address Query