1
0
forked from docs/doc-exports
doc-exports/docs/vpc/api-ref/vpc_ipv6_0002.html
Qin Ying, Fan 7e6f07b803 VPC API 20240320 version
Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com>
Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>
2024-09-05 12:25:23 +00:00

12 KiB

Querying a Floating IP Address

Function

This API is used to query details about a specific floating IP address accessible to the tenant submitting the request.

URI

GET /v2.0/eip/floatingips_v6/{floatingip_id}

Request Message

  • Request parameter

    None

  • Example request
    GET https://{Endpoint}//v2.0/eip/floatingips_v6/2dedb5e7-cb70-4e78-b50f-d88c8321d161

Response Message

  • Response parameter
    Table 1 Response parameter

    Parameter

    Type

    Description

    floatingip

    floatingip object

    Specifies the floating IP address list. For details, see Table 2.

    Table 2 floatingip objects

    Parameter

    Type

    Description

    status

    String

    Specifies the floating IP address status. The value can be ACTIVE, DOWN, or ERROR.

    • ACTIVE indicates that the floating IP address has been bound.
    • ERROR indicates that the floating IP address is abnormal.
    • DOWN indicates that the floating IP address has not been bound.

    id

    String

    Specifies the floating IP address ID.

    floating_ip_address

    String

    Specifies the floating IPv6 address.

    floating_network_id

    String

    Specifies the external network ID.

    router_id

    String

    Specifies the ID of the belonged router.

    port_id

    String

    Specifies the port ID.

    fixed_ip_address

    String

    Specifies the private IP address of the associated port.

    tenant_id

    String

    Specifies the project ID.

    project_id

    String

    Specifies the project ID.

    created_at

    String

    Specifies the time when the resource was created.

    Format: yyyy-MM-ddTHH:mm:ss

    updated_at

    String

    Specifies the time when the resource was updated.

    Format: yyyy-MM-ddTHH:mm:ss

  • Example response
    {
      "floatingip": {
        "id": "861a4c5b-b17b-4a1d-b653-f3e95dcb3345",
        "status": "DOWN",
        "router_id": null,
        "tenant_id": "26ae5181a416420998eb2093aaed84d9",
        "floating_network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975",
        "fixed_ip_address": null,
        "floating_ip_address": "cdcd:910a:2222:5498:8475:1111:c613:16e3",
        "port_id": null,
        "project_id": "26ae5181a416420998eb2093aaed84d9",
        "created_at": "2024-05-23T09:20:59",
        "updated_at": "2024-05-28T15:02:53"
      }
    }

Status Code

See Status Codes.

Error Code

See Error Codes.