Help Center/ Bare Metal Server/ API Reference/ Native OpenStack Nova V2.1 APIs/ BMS IP Address Query/ Querying the Specified IP Address of a BMS (Native OpenStack API)
Updated on 2024-05-17 GMT+08:00
View PDF

Querying the Specified IP Address of a BMS (Native OpenStack API)

Function

This API is used to query the specified IP address of a BMS based on the network name.

URI

GET /v2.1/{project_id}/servers/{server_id}/ips/{vpc_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).

vpc_id

Yes

Specifies the ID of the VPC where the BMS is located.

Request Parameters

None

Example Request

Querying the IP address of a BMS (ID: 95bf2490-5428-432c-ad9b-5e3406f869dd) in a specified VPC 
1
 
GET https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/ips/{vpc_id}

Response Parameters

Parameter

Type

Description

Vpc_id

Array of address objects

Specifies the VPC used by the BMS.

Vpc_id indicates the ID of the VPC used by the BMS.
Table 2 Network 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
 
{ 
     "Vpc_id": [ 
         { 
             "version": 4, 
             "addr": "192.168.1.159" 
         } 
     ] 
 }

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 IP Address Query