• Virtual Private Cloud

vpc
  1. Help Center
  2. Virtual Private Cloud
  3. API Reference
  4. APIs
  5. Elastic IP Address
  6. Assigning an EIP

Assigning an EIP

Function

This interface is used to assign an EIP. 

URI

POST /v1/{project_id}/publicips
Table 1 Parameter description

Name

Mandatory

Description

project_id

Yes

Specifies the project ID.

Request Message

  • Request parameter
    Table 2 Request parameter

    Name

    Mandatory

    Type

    Description

    publicip

    Yes

    Dictionary data structure

    Specifies the EIP object.

    bandwidth

    Yes

    Dictionary data structure

    Specifies the bandwidth object.

    Table 3 Description of the publicip field

    Name

    Mandatory

    Type

    Description

    type

    Yes

    String

    • Specifies the EIP type.
    • The value is 5_bgp.
    • The configured value must be supported by the system.

    ip_address

    No

    String

    • Specifies the EIP to be assigned. The system automatically assigns an EIP if you do not specify it.
    • The value must be a valid IPv4 address in the available IP address range

    Table 4 Description of the bandwidth field

    Name

    Mandatory

    Type

    Description

    name

    Yes

    String

    • Specifies the bandwidth name.
    • The value is a string of 1 to 64 characters that can contain letters, digits, underscores (_), hyphens (-), and periods (.).
    • This parameter is mandatory when share_type is set to PER. This parameter will be ignored when share_type is set to WHOLE with an ID specified.

    size

    Yes

    int

    • Specifies the bandwidth size.
    • The value ranges from 1 Mbit/s to 1000 Mbit/s by default. (The specific range may vary depending on the configuration in each region. You can see the bandwidth range of each region on the management console.)
    • This parameter is mandatory when share_type is set to PER. This parameter will be ignored when share_type is set to WHOLE with an ID specified.
    • The minimum unit for bandwidth adjustment varies depending on the bandwidth range. The details are as follows:
      • The minimum unit is 1 Mbit/s if the allowed bandwidth size ranges from 0 to 300 Mbit/s (with 300 Mbit/s included).
      • The minimum unit is 50 Mbit/s if the allowed bandwidth size ranges 300 Mbit/s to 1000 Mbit/s (with 1000 Mbit/s included).
      • The minimum unit is 500 Mbit/s if the allowed bandwidth size is greater than 1000 Mbit/s.

    share_type

    Yes

    String

    • Specifies the bandwidth type.
    • The value is PER, indicating that the bandwidth is dedicated.

    charge_mode

    No

    String

    • The value is traffic, indicating that the billing is based on traffic.
  • Example request
    {
        "publicip": {
            "type": "5_bgp"
        },
        "bandwidth": {
            "name": "bandwidth123",
            "size": 10,
            "share_type": "PER"
        }
    }

Response Message

  • Response parameter
    Table 5 Response parameter

    Name

    Type

    Description

    publicip

    Dictionary data structure

    Specifies the EIP object.

    Table 6 Description of the publicip field

    Name

    Type

    Description

    id

    String

    Specifies the unique identifier of the 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)
      • NOTIFYING (Assigning)
      • NOTIFY_DELETE (Releasing)
      • PENDING_UPDATE (Updating)
      • DOWN (Unbound)
      • ACTIVE (Bound)
      • ELB (Bound to a load balancer)
      • ERROR (Failed)

    type

    String

    Specifies the EIP type.

    public_ip_address

    String

    Specifies the obtained EIP if only IPv4 EIPs are available.

    tenant_id

    String

    Specifies the project ID.

    create_time

    String

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

    bandwidth_size

    int

    Specifies the bandwidth size.

  • Example response
    {
        "publicip": {
            "id": "f588ccfa-8750-4d7c-bf5d-2ede24414706",
            "status": "PENDING_CREATE",
            "type": "5_bgp",
            "public_ip_address": "161.xx.xx.7",
            "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c",
            "create_time": "2015-07-16 04:10:52",
            "bandwidth_size": 0
            
        }
    }

Status Codes

For details, see section Status Codes.

Error Codes

For details, see section Error Codes.