sgode/virtual-private-cloud
1
0
Fork 0
forked from docs/virtual-private-cloud
Code Pull Requests Activity
virtual-private-cloud/api-ref/source/apis/eip/assigning_an_eip.rst
proposalbot a539bdd666 Changes to vpc_api-ref from docs/doc-exports#556 (VPC API 20230106 version 
VPC

Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com>
Reviewed-by: Hajba, László Antal <laszlo-antal.hajba@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2024-02-06 09:16:27 +00:00

29 KiB
Raw Blame History

original_name

en-us_topic_0020090596.html

Assigning an EIP

Function

This API is used to assign an EIP.

The EIP service provides independent public IP addresses and bandwidth for Internet access. EIPs can be bound to or unbound from ECSs, BMSs, virtual IP addresses, NAT gateways, or load balancers.

Note

Note the following when you use EIPs of the Dedicated Load Balancer (5_gray) type:

  • In eu-de, EIPs of the Dedicated Load Balancer (5_gray) type cannot be assigned anymore. You can assign EIPs of the BGP (5_bgp) type.
  • Existing EIPs of the Dedicated Load Balancer (5_gray) type can be bound to dedicated or shared load balancers.
    • The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers.
    • You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see Binding an EIP and Unbinding an EIP.
    • EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs.
    • You are advised to bind BGP EIPs to or unbind them from dedicated load balancers.
  • Do not add EIPs of the dedicated load balancer type (5_gray) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect.

URI

POST /v1/{project_id}/publicips

Table 1 <en-us_topic_0020090596__table57311924> describes the parameters.

Table 1 Parameter description
Name Mandatory Description
project_id Yes Specifies the project ID.

Request Parameters

Table 2 Request body parameter
Name Mandatory Type Description
publicip Yes publicip <en-us_topic_0020090596__table4491214> object Specifies the EIP object. For details, see Table 3 <en-us_topic_0020090596__table4491214>.
bandwidth Yes bandwidth <en-us_topic_0020090596__table11041789> object Specifies the bandwidth object. For details, see Table 4 <en-us_topic_0020090596__table11041789>.
Table 3 Description of the publicip field
Name Mandatory Type Description
type Yes String
  • Specifies the EIP type.
  • The value can be 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), or 5_gray (Dedicated Load Balancer).
  • 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.
ip_version No Integer
  • Specifies the EIP version.
  • The value can be 4 and 6, indicating IPv4 address and IPv6 address, respectively. IPv6 is not supported currently.
  • Constraints:
    • The configured value must be supported by the system.
    • If this parameter is left blank or is an empty string, IPv4 address is created by default.
alias No String
  • Specifies the EIP name.
  • The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
Table 4 Description of the bandwidth field
Name Mandatory Type Description
name Yes String
  • Specifies the bandwidth name.
  • The value can contain 1 to 64 characters, including 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 Integer
  • 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 increment for bandwidth adjustment varies depending on the bandwidth range. The details are as follows:
    • The minimum increment is 1 Mbit/s if the allowed bandwidth ranges from 0 Mbit/s to 300 Mbit/s (with 300 Mbit/s included).
    • The minimum increment is 50 Mbit/s if the allowed bandwidth ranges from 300 Mbit/s to 1000 Mbit/s (with 1000 Mbit/s included).
    • The minimum increment is 500 Mbit/s if the allowed bandwidth is greater than 1000 Mbit/s.
id No String
  • Specifies the bandwidth ID. You can specify an existing shared bandwidth when assigning an EIP.
  • The value can be the ID of the shared bandwidth whose type is set to WHOLE.
share_type Yes String
  • Specifies the bandwidth type.
  • Possible values are as follows:
    • PER: Dedicated bandwidth
    • WHOLE: Shared bandwidth
  • If this parameter is set to WHOLE, the bandwidth ID must be specified.
charge_mode No String
  • The value is traffic, indicating that the billing is based on traffic.

Example Request

Example request (IPv4 EIP with dedicated bandwidth)

POST https://{Endpoint}/v1/{project_id}/publicips

{
    "publicip": {
        "type": "5_bgp",
        "ip_version": 4
    },
    "bandwidth": {
        "name": "bandwidth123",
        "size": 10,
        "share_type": "PER"
    }
}

Response Message

  • Response parameter

    Table 5 Response parameter
    Name Type Description
    publicip publicip <en-us_topic_0020090596__table44471219> object Specifies the EIP object. For details, see Table 6 <en-us_topic_0020090596__table44471219>.
    Table 6 Description of the publicip 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 (Release)
      • DOWN (Unbound)
      • ACTIVE (Bound)
      • ELB (Bound to a load balancer)
      • VPN (Bound to a VPN)
      • ERROR (Exceptions)
    type String
    • Specifies the EIP type.
    • The value can be 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), or 5_gray (Dedicated Load Balancer).
    • 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.
    ip_version Integer

    Specifies the IP address version. The value can be 4 or 6.

    • 4: IPv4
    • 6: IPv6 (IPv6 is not supported currently.)
    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_size Integer Specifies the bandwidth (Mbit/s).
    alias String Specifies the EIP name.
    enterprise_project_id String
    • Specifies the enterprise project ID. The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-).
    • When you assign an EIP, associate an enterprise project ID with the EIP.
    • If this parameter is not specified, the default value is 0, which indicates that the default enterprise project is used.
    public_border_group String

    Specifies whether it is in a central site or an edge site.

    The value can be:

    • center
    • Edge site name

    This resource can only be associated with an EIP of the same region.

Example Response

Example response (IPv4 EIP with dedicated bandwidth)

{
    "publicip": {
        "id": "f588ccfa-8750-4d7c-bf5d-2ede24414706",
        "alias": "tom",
        "public_border_group": "center",
        "status": "PENDING_CREATE",
        "type": "5_bgp",
        "public_ip_address": "161.xx.xx.7",
        "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c",
        "ip_version": 4,
        "create_time": "2015-07-16 04:10:52",
        "bandwidth_size": 0,
        "enterprise_project_id": "b261ac1f-2489-4bc7-b31b-c33c3346a439"
    }
}

Status Code

See Status Codes <vpc_api_0002>.

Error Code

See Error Codes <vpc_api_0003>.