doc-exports/docs/bms/api-ref/en-us_topic_0053158662.html
Hasko, Vladimir daef1357e6 manually adding BMS content due to bug in gitea
Reviewed-by: Kucerak, Kristian <kristian.kucerak@t-systems.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2022-10-25 09:38:20 +00:00

13 KiB

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 how to obtain the project ID, see Obtaining Required Information.

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.

vpc_id

Yes

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

Request

  • Request parameters

    None

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

Response

  • Response parameters

    Parameter

    Type

    Description

    VPC where the BMS is located

    Array of objects

    Specifies the ID of the VPC where the BMS is located. For details about the format, see Table 2.

    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
    {
        "5849fdf1-9d79-4589-80c2-fe557990c417": [
            {
                "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.