Updated on 2024-04-15 GMT+08:00

Updating an EIP

Function

This API is used to convert the EIP version, bind an EIP to a NIC, or unbind an EIP from a NIC.

URI

PUT /v1/{project_id}/publicips/{publicip_id}

Table 1 describes the parameters.
Table 1 Parameter description

Name

Mandatory

Description

project_id

Yes

Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID.

publicip_id

Yes

Specifies the unique identifier of an EIP.

Request Message

  • Request parameter
    Table 2 Request parameter

    Name

    Mandatory

    Type

    Description

    publicip

    Yes

    publicip object

    Specifies the EIP object. For details, see Table 3.

    Table 3 Description of the publicip field

    Name

    Mandatory

    Type

    Description

    port_id

    No

    String

    • Specifies the port ID.
    • The value must be an existing port ID. If this parameter is not included or the parameter value is left blank, the EIP is unbound. If the specified port ID does not exist or has already been bound with an EIP, an error message will be displayed.

    alias

    No

    String

    • Specifies the EIP name.
    • The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
  • Example request 1 (Binding an EIP to a NIC)
    PUT https://{Endpoint}/v1/{project_id}/publicips/{publicip_id}
    
    {
        "publicip": {
            "port_id": "f588ccfa-8750-4d7c-bf5d-2ede24414706"
        }
    }

Response Message

  • Response parameter
    Table 4 Response parameter

    Name

    Type

    Description

    publicip

    publicip object

    Specifies the EIP object. For details, see Table 5.

    Table 5 Description of the publicips field

    Name

    Type

    Description

    id

    String

    Specifies the unique identifier of an EIP.

    status

    String

    • Specifies the EIP status.
    • Possible values are as follows:
      • FREEZED (Frozen)
      • BIND_ERROR (Binding failed)
      • BINDING (Binding)
      • PENDING_DELETE (Releasing)
      • PENDING_CREATE (Assigning)
      • PENDING_UPDATE (Updating)
      • NOTIFYING (Assigning)
      • NOTIFY_DELETE (Releasing)
      • DOWN (Unbound)
      • ACTIVE (Bound)
      • ELB (Bound to a load balancer)
      • ERROR (Exceptions)

    type

    String

    • Specifies the EIP type.
    • Constraints:
      • The configured value must be supported by the system.
      • publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.

    public_ip_address

    String

    Specifies the obtained EIP if only IPv4 EIPs are available.

    private_ip_address

    String

    • Specifies the private IP address bound to the EIP.
    • This parameter is returned only when a port is associated with the EIP.

    port_id

    String

    • Specifies the port ID.
    • This parameter is returned only when a port is associated with the EIP.

    tenant_id

    String

    Specifies the project ID.

    create_time

    String

    Specifies the time (UTC) when the EIP is assigned.

    Format: yyyy-MM-dd HH:mm:ss

    bandwidth_id

    String

    Specifies the ID of the EIP bandwidth.

    bandwidth_size

    Integer

    Specifies the bandwidth (Mbit/s).

    bandwidth_share_type

    String

    • Specifies the EIP bandwidth type.
    • The value can be PER or WHOLE.
      • PER: Dedicated bandwidth
      • WHOLE: Shared bandwidth

    alias

    String

    Specifies the EIP name.

  • Example response (Binding an EIP to a NIC)
    {
      "publicip": {
        "id": "f6318bef-6508-4ea5-a48f-6152b6b1a8fb",
        "status": "ACTIVE",
        "alias": "tom",
        "type": "5_bgp",
        "port_id": "a135e9b8-1630-40d2-a6c5-eb534a61efbe",
        "public_ip_address": "10.xx.xx.162",
        "private_ip_address": "192.168.1.131",
        "tenant_id": "26ae5181a416420998eb2093aaed84d9",
        "create_time": "2019-03-27 01:33:18",
        "bandwidth_size": 7,
        "ip_version": 4,
        "bandwidth_name": "bandwidth-2aef",
        "bandwidth_share_type": "PER",
        "bandwidth_id": "7a258fff-10d8-44b8-8124-c59079eb8f4c"
      }
    }

Status Code

See Status Codes.

Error Code

See Error Codes.