Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive
Help Center/ Elastic IP/ API Reference/ APIs/ EIP/ Assigning an EIP (Pay-per-Use)

Assigning an EIP (Pay-per-Use)

Updated on 2025-02-08 GMT+08:00

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. Various billing modes are provided to meet diversified service requirements.

URI

POST /v1/{project_id}/publicips

Table 1 describes the parameters.
Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

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

Request Parameters

Table 2 Request body parameter

Parameter

Mandatory

Type

Description

publicip

Yes

publicip object

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

bandwidth

Yes

bandwidth object

Specifies the bandwidth object. For details, see Table 4.

enterprise_project_id

No

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.
NOTE:

For more information about enterprise projects and how to obtain enterprise project IDs, see the Enterprise Management User Guide.

Table 3 Description of the publicip field

Parameter

Mandatory

Type

Description

type

Yes

String

  • Specifies the EIP type.
  • The value can be 5_bgp (dynamic BGP) or 5_sbgp (static BGP).
    • CN South-Guangzhou: 5_bgp and 5_sbgp
    • CN East-Shanghai1: 5_bgp and 5_sbgp
    • CN East-Shanghai2: 5_bgp and 5_sbgp
    • CN North-Beijing1: 5_bgp and 5_sbgp
    • CN-Hong Kong: 5_bgp
    • AP-Bangkok: 5_bgp
    • AP-Singapore: 5_bgp
    • AF-Johannesburg: 5_bgp
    • CN Southwest-Guiyang1: 5_sbgp
    • CN North-Beijing4: 5_bgp and 5_sbgp
    • LA-Santiago: 5_bgp
    • LA-Sao Paulo1: 5_bgp
    • LA-Mexico City1: 5_bgp
    • LA-Buenos Aires1: 5_bgp
    • LA-Lima1: 5_bgp
    • LA-Santiago2: 5_bgp
  • 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.
  • 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.

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.

alias

No

String

  • Specifies the EIP name.
  • The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).

port_id

No

String

  • Specifies the port ID. The EIP to be assigned is bound to this port.
  • The value must be an ID of an existing port. If the port does not exist or has been bound to an EIP, an error message is displayed.
Table 4 Description of the bandwidth field

Parameter

Mandatory

Type

Description

name

No

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

No

Integer

  • Specifies the bandwidth size.
  • The value ranges from 1 Mbit/s to 300 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

  • Specifies whether the bandwidth is billed by traffic or by bandwidth size.
  • The value bandwidth indicates that you will be billed by bandwidth, and the value traffic indicates that you will be billed by 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"
    },
    "enterprise_project_id":"b261ac1f-2489-4bc7-b31b-c33c3346a439"
}

Response Message

  • Response parameter
    Table 5 Response parameter

    Parameter

    Type

    Description

    publicip

    publicip object

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

    Table 6 Description of the publicip field

    Parameter

    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) or 5_sbgp (static BGP).
      • CN South-Guangzhou: 5_bgp and 5_sbgp
      • CN East-Shanghai1: 5_bgp and 5_sbgp
      • CN East-Shanghai2: 5_bgp and 5_sbgp
      • CN North-Beijing1: 5_bgp and 5_sbgp
      • CN-Hong Kong: 5_bgp
      • AP-Bangkok: 5_bgp
      • AP-Singapore: 5_bgp
      • AF-Johannesburg: 5_bgp
      • CN Southwest-Guiyang1: 5_sbgp
      • CN North-Beijing4: 5_bgp and 5_sbgp
      • LA-Santiago: 5_bgp
      • LA-Sao Paulo1: 5_bgp
      • LA-Mexico City1: 5_bgp
      • LA-Buenos Aires1: 5_bgp
      • LA-Lima1: 5_bgp
      • LA-Santiago2: 5_bgp
    • 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.

    public_ipv6_address

    String

    Specifies the obtained EIP if IPv6 EIPs are available. This parameter does not exist 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

    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.
    NOTE:

    For more information about enterprise projects and how to obtain enterprise project IDs, see the Enterprise Management User Guide.

    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.

Error Code

See Error Codes.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback