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/ API V3/ EIPs/ Adding EIPs to a Shared Bandwidth in Batches

Adding EIPs to a Shared Bandwidth in Batches

Function

This API is used to add multiple EIPs to a shared bandwidth.

URI

POST /v3/{project_id}/eip/publicips/attach-share-bandwidth

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Minimum length: 32

Maximum length: 32

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

publicips

No

Array of BatchAttachSharebwDict objects

  • EIPs in a shared bandwidth

  • If multiple EIPs are added to a shared bandwidth, the value of bandwidth_id of these EIPs must be the same.

Array length: 1 to 50

Table 3 BatchAttachSharebwDict

Parameter

Mandatory

Type

Description

bandwidth_id

No

String

  • Shared bandwidth ID

Minimum length: 36

Maximum length: 36

publicip_id

No

String

  • EIP ID

Minimum length: 36

Maximum length: 36

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

publicips

Array of BatchPublicipResp objects

EIPs

request_id

String

Request ID

Table 5 BatchPublicipResp

Parameter

Type

Description

statusCode

Integer

Status code

publicip

PublicipResp object

EIP

Table 6 PublicipResp

Parameter

Type

Description

id

String

  • EIP ID, which uniquely identifies the EIP.

Minimum length: 36

Maximum length: 36

project_id

String

  • Project ID

Minimum length: 32

Maximum length: 32

ip_version

Integer

  • EIP version

  • The value can be 4 or 6. 6 indicates that the NAT64 capability is enabled.

    • 4: IPv4 EIP

    • 6: IPv6 EIP

Minimum value: 4

Maximum value: 6

public_ip_address

String

  • IPv4 EIP

Minimum length: 0

Maximum length: 64

public_ipv6_address

String

  • IPv6 EIP

Minimum length: 0

Maximum length: 64

status

String

  • EIP status

  • The value can be FREEZED, DOWN, ACTIVE, or ERROR.

    • FREEZED: The EIP is frozen.

    • DOWN: The EIP is not bound to any instance.

    • ACTIVE: The EIP is bound to an instance and is in use.

    • ERROR: The EIP status is abnormal.

Minimum length: 0

Maximum length: 16

description

String

  • Supplementary information about the EIP

  • You can customize this value to identify your EIP, which is not perceived by the system.

Minimum length: 0

Maximum length: 1024

created_at

String

  • Time when an EIP is assigned

  • The value is in UTC format, for example, 2018-12-25T10:07:24Z.

Minimum length: 0

Maximum length: 64

updated_at

String

  • Time when an EIP is updated

  • The value is in UTC format, for example, 2018-12-25T10:09:20Z.

Minimum length: 0

Maximum length: 64

type

String

  • EIP type

  • The value can be EIP or DUALSTACK.

Minimum length: 0

Maximum length: 36

vnic

VnicResp object

  • Port information of the instance with an EIP bound

  • If the instance has no port, the value is null.

bandwidth

BandwidthResp object

  • Bandwidth of an EIP

enterprise_project_id

String

  • Enterprise project ID of the EIP

Minimum length: 32

Maximum length: 32

billing_info

String

  • Order information of an EIP

  • The value is available only for yearly/monthly resources. This value is left blank for pay-per-use resources.

Minimum length: 0

Maximum length: 1024

lock_status

String

  • Frozen status of an EIP

  • The metadata type indicates that the EIP is frozen due to arrears or security reasons.

Minimum length: 0

Maximum length: 36

associate_instance_type

String

  • Type of the instance with an EIP bound

  • The value can be PORT, NATGW, ELB, ELBV1, or VPN.

Minimum length: 0

Maximum length: 36

associate_instance_id

String

  • ID of the instance with an EIP bound

Minimum length: 0

Maximum length: 36

publicip_pool_id

String

  • ID of the network that an EIP belongs to. It is the network ID corresponding to publicip_pool_name.

Minimum length: 36

Maximum length: 36

publicip_pool_name

String

  • Network type of an EIP,

    including public EIP pool (for example, 5_bgp or 5_sbgp) and dedicated EIP pool. For details about the dedicated EIP pool, see the APIs about publcip_pool.

Minimum length: 0

Maximum length: 128

alias

String

  • EIP alias

Minimum length: 0

Maximum length: 255

public_border_group

String

  • Whether it is a central or an edge EIP. The value is CENTER for a central EIP and an edge AZ name for an edge EIP.

Minimum length: 0

Maximum length: 64

Table 7 VnicResp

Parameter

Type

Description

private_ip_address

String

  • Private IP address of a port

Minimum length: 0

Maximum length: 36

device_id

String

  • Device ID of a port

  • If there is a port, the value of this parameter is the same as that of associate_instance_id.

Minimum length: 0

Maximum length: 36

device_owner

String

  • Device owner of a port

  • If there is a port, this parameter and associate_instance_type can be used to identify the instance type.

Minimum length: 0

Maximum length: 36

vtep

String

  • VTEP IP address

Minimum length: 0

Maximum length: 36

vni

String

  • VXLAN ID

Minimum length: 0

Maximum length: 36

vpc_id

String

  • ID of the VPC that the port belongs to

Minimum length: 36

Maximum length: 36

port_id

String

  • Port ID, which uniquely identifies a port.

Minimum length: 36

Maximum length: 36

port_profile

String

  • Port profile

Minimum length: 0

Maximum length: 256

mac

String

  • MAC address of a port

Minimum length: 0

Maximum length: 36

instance_id

String

  • User of a port, which is different from the owner of device_id. For example, the device_owner of a virtual IP address port is a virtual IP address, but the actual user of the port may be a VM or others.

Minimum length: 0

Maximum length: 36

instance_type

String

  • Instance type. This parameter is used together with instance_id.

Minimum length: 0

Maximum length: 36

port_vif_details

String

  • Details about the NIC virtual interface.

Minimum length: 0

Maximum length: 255

Table 8 BandwidthResp

Parameter

Type

Description

id

String

  • Bandwidth ID

Minimum length: 36

Maximum length: 36

size

Integer

  • Bandwidth size

Minimum value: 0

Maximum value: 2000

share_type

String

  • Bandwidth type

    WHOLE indicates a shared bandwidth, and PER indicates a dedicated bandwidth.

Minimum length: 0

Maximum length: 36

charge_mode

String

  • Bandwidth billing mode

Minimum length: 0

Maximum length: 36

name

String

  • Bandwidth name

Minimum length: 0

Maximum length: 255

billing_info

String

  • Bandwidth order information

Minimum length: 0

Maximum length: 1024

Example Request

If multiple EIPs are added to the same shared bandwidth, the bandwidth ID of these EIPs must be the same.

POST /v3/{project_id}/eip/publicips/attach-share-bandwidth

{
  "publicips" : [ {
    "bandwidth_id" : "e6af636c-ea79-4c20-ba2f-402057ba7886",
    "publicip_id" : "99c8a2df-9e90-48df-9132-e2216e659459"
  }, {
    "bandwidth_id" : "e6af636c-ea79-4c20-ba2f-402057ba7886",
    "publicip_id" : "7b484d78-550a-4e92-8363-a34b5194ddcb"
  } ]
}

Example Response

Status code: 200

Normal response to POST requests

{
  "publicips" : [ {
    "statusCode" : 200,
    "publicip" : {
      "alias" : "test",
      "associate_instance_id" : null,
      "associate_instance_type" : null,
      "bandwidth" : {
        "id" : "e6af636c-ea79-4c20-ba2f-402057ba7886",
        "size" : 5,
        "share_type" : "WHOLE",
        "charge_mode" : "traffic",
        "name" : "bandwidth-b8ff",
        "billing_info" : ""
      },
      "billing_info" : null,
      "created_at" : "2020-07-10T10:10:18Z",
      "description" : "",
      "enterprise_project_id" : "0",
      "id" : "99c8a2df-9e90-48df-9132-e2216e659459",
      "ip_version" : 4,
      "lock_status" : null,
      "project_id" : "8d53f081ea24444aa95e2bfa942ef6ee",
      "public_border_group" : "center",
      "public_ip_address" : "10.246.165.44",
      "public_ipv6_address" : null,
      "publicip_pool_id" : "ece62314-858c-4793-a768-346efca42131",
      "publicip_pool_name" : "5_bgp",
      "status" : "ACTIVE",
      "type" : "EIP",
      "updated_at" : "2020-07-11T05:03:25Z",
      "vnic" : {
        "device_id" : "cc03e7f7-b820-4a2e-b243-8022daabf0cf",
        "device_owner" : "compute:br-iaas-odin1a",
        "instance_id" : "",
        "instance_type" : "",
        "mac" : "fa:16:3e:7a:5f:db",
        "port_id" : "fb68a8e1-b93e-4100-8735-6d6b0a6a0eb5",
        "port_profile" : "",
        "private_ip_address" : "192.168.3.222",
        "vni" : "435405",
        "vpc_id" : "ac17491b-0769-4d96-b883-6d6295f6afad",
        "vtep" : "18.8.152.158",
        "port_vif_details" : "{\"primary_interface\": true}"
      }
    }
  }, {
    "statusCode" : 200,
    "publicip" : {
      "alias" : "test",
      "associate_instance_id" : null,
      "associate_instance_type" : null,
      "bandwidth" : {
        "id" : "e6af636c-ea79-4c20-ba2f-402057ba7886",
        "size" : 5,
        "share_type" : "WHOLE",
        "charge_mode" : "traffic",
        "name" : "bandwidth-b8ff",
        "billing_info" : ""
      },
      "billing_info" : null,
      "created_at" : "2020-07-10T10:10:18Z",
      "description" : "",
      "enterprise_project_id" : "0",
      "id" : "7b484d78-550a-4e92-8363-a34b5194ddcb",
      "ip_version" : 4,
      "lock_status" : null,
      "project_id" : "8d53f081ea24444aa95e2bfa942ef6ee",
      "public_border_group" : "center",
      "public_ip_address" : "10.246.165.45",
      "public_ipv6_address" : null,
      "publicip_pool_id" : "ece62314-858c-4793-a768-346efca42131",
      "publicip_pool_name" : "5_bgp",
      "status" : "ACTIVE",
      "type" : "EIP",
      "updated_at" : "2020-07-11T05:03:25Z",
      "vnic" : {
        "device_id" : "cc03e7f7-b820-4a2e-b243-8022daabf0dd",
        "device_owner" : "compute:br-iaas-odin1a",
        "instance_id" : "",
        "instance_type" : "",
        "mac" : "fa:16:3e:7a:5f:cc",
        "port_id" : "fb68a8e1-b93e-4100-8735-6d6b0a6a0eb6",
        "port_profile" : "",
        "private_ip_address" : "192.168.3.221",
        "vni" : "435405",
        "vpc_id" : "ac17491b-0769-4d96-b883-6d6295f6afad",
        "vtep" : "18.8.152.158",
        "port_vif_details" : "{\"primary_interface\": true}"
      }
    }
  } ],
  "request_id" : "db4b975a79d1da86dda3d02054f11e16"
}

SDK Sample Code

The sample code is as follows:

Java

If multiple EIPs are added to the same shared bandwidth, the bandwidth ID of these EIPs must be the same.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.eip.v3.region.EipRegion;
import com.huaweicloud.sdk.eip.v3.*;
import com.huaweicloud.sdk.eip.v3.model.*;

import java.util.List;
import java.util.ArrayList;

public class AttachBatchPublicIpSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        EipClient client = EipClient.newBuilder()
                .withCredential(auth)
                .withRegion(EipRegion.valueOf("<YOUR REGION>"))
                .build();
        AttachBatchPublicIpRequest request = new AttachBatchPublicIpRequest();
        BatchAttachSharebwReq body = new BatchAttachSharebwReq();
        List<BatchAttachSharebwDict> listbodyPublicips = new ArrayList<>();
        listbodyPublicips.add(
            new BatchAttachSharebwDict()
                .withBandwidthId("e6af636c-ea79-4c20-ba2f-402057ba7886")
                .withPublicipId("99c8a2df-9e90-48df-9132-e2216e659459")
        );
        listbodyPublicips.add(
            new BatchAttachSharebwDict()
                .withBandwidthId("e6af636c-ea79-4c20-ba2f-402057ba7886")
                .withPublicipId("7b484d78-550a-4e92-8363-a34b5194ddcb")
        );
        body.withPublicips(listbodyPublicips);
        request.withBody(body);
        try {
            AttachBatchPublicIpResponse response = client.attachBatchPublicIp(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Python

If multiple EIPs are added to the same shared bandwidth, the bandwidth ID of these EIPs must be the same.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkeip.v3.region.eip_region import EipRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkeip.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = EipClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(EipRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = AttachBatchPublicIpRequest()
        listPublicipsbody = [
            BatchAttachSharebwDict(
                bandwidth_id="e6af636c-ea79-4c20-ba2f-402057ba7886",
                publicip_id="99c8a2df-9e90-48df-9132-e2216e659459"
            ),
            BatchAttachSharebwDict(
                bandwidth_id="e6af636c-ea79-4c20-ba2f-402057ba7886",
                publicip_id="7b484d78-550a-4e92-8363-a34b5194ddcb"
            )
        ]
        request.body = BatchAttachSharebwReq(
            publicips=listPublicipsbody
        )
        response = client.attach_batch_public_ip(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

If multiple EIPs are added to the same shared bandwidth, the bandwidth ID of these EIPs must be the same.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    eip "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := eip.NewEipClient(
        eip.EipClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.AttachBatchPublicIpRequest{}
	bandwidthIdPublicips:= "e6af636c-ea79-4c20-ba2f-402057ba7886"
	publicipIdPublicips:= "99c8a2df-9e90-48df-9132-e2216e659459"
	bandwidthIdPublicips1:= "e6af636c-ea79-4c20-ba2f-402057ba7886"
	publicipIdPublicips1:= "7b484d78-550a-4e92-8363-a34b5194ddcb"
	var listPublicipsbody = []model.BatchAttachSharebwDict{
        {
            BandwidthId: &bandwidthIdPublicips,
            PublicipId: &publicipIdPublicips,
        },
        {
            BandwidthId: &bandwidthIdPublicips1,
            PublicipId: &publicipIdPublicips1,
        },
    }
	request.Body = &model.BatchAttachSharebwReq{
		Publicips: &listPublicipsbody,
	}
	response, err := client.AttachBatchPublicIp(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More SDK Sample Code

For more SDK sample codes of programming languages, visit API Explorer and click the Sample Code tab. Example codes can be automatically generated.

Status Codes

Status Code

Description

200

Normal response to POST requests

Error Codes

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