Adding EIPs to a Shared Bandwidth in Batches
Function
This API is used to add EIPs to a shared bandwidth in batches.
URI
POST /v3/{project_id}/eip/publicips/attach-share-bandwidth
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID Minimum length: 32 Maximum length: 32 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
publicips |
No |
Array of BatchAttachSharebwDict objects |
Array length: 1 to 50 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
publicips |
Array of BatchPublicipResp objects |
EIPs. |
request_id |
String |
Request ID |
Parameter |
Type |
Description |
---|---|---|
statusCode |
Integer |
Status code |
publicip |
PublicipResp object |
EIP |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Minimum length: 36 Maximum length: 36 |
project_id |
String |
Minimum length: 32 Maximum length: 32 |
ip_version |
Integer |
Minimum value: 4 Maximum value: 6 The value can be:
|
public_ip_address |
String |
Minimum length: 0 Maximum length: 64 |
public_ipv6_address |
String |
Minimum length: 0 Maximum length: 64 |
status |
String |
Minimum length: 0 Maximum length: 16 The value can be:
|
description |
String |
Minimum length: 0 Maximum length: 1024 |
created_at |
String |
Minimum length: 0 Maximum length: 64 |
updated_at |
String |
Minimum length: 0 Maximum length: 64 |
type |
String |
Minimum length: 0 Maximum length: 36 The value can be:
|
vnic |
VnicResp object |
|
bandwidth |
BandwidthResp object |
|
enterprise_project_id |
String |
Minimum length: 32 Maximum length: 32 |
billing_info |
String |
Minimum length: 0 Maximum length: 1024 |
lock_status |
String |
Minimum length: 0 Maximum length: 36 |
associate_instance_type |
String |
Minimum length: 0 Maximum length: 36 The value can be:
|
associate_instance_id |
String |
Minimum length: 0 Maximum length: 36 |
publicip_pool_id |
String |
Minimum length: 36 Maximum length: 36 |
publicip_pool_name |
String |
Minimum length: 0 Maximum length: 128 |
alias |
String |
Minimum length: 0 Maximum length: 255 |
public_border_group |
String |
Minimum length: 0 Maximum length: 64 |
Parameter |
Type |
Description |
---|---|---|
private_ip_address |
String |
Minimum length: 0 Maximum length: 36 |
device_id |
String |
Minimum length: 0 Maximum length: 36 |
device_owner |
String |
Minimum length: 0 Maximum length: 36 |
vtep |
String |
Minimum length: 0 Maximum length: 36 |
vni |
String |
Minimum length: 0 Maximum length: 36 |
vpc_id |
String |
Minimum length: 36 Maximum length: 36 |
port_id |
String |
Minimum length: 36 Maximum length: 36 |
port_profile |
String |
Minimum length: 0 Maximum length: 256 |
mac |
String |
Minimum length: 0 Maximum length: 36 |
instance_id |
String |
Minimum length: 0 Maximum length: 36 |
instance_type |
String |
Minimum length: 0 Maximum length: 36 |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Minimum length: 36 Maximum length: 36 |
size |
Integer |
Minimum value: 0 Maximum value: 2000 |
share_type |
String |
Minimum length: 0 Maximum length: 36 |
charge_mode |
String |
Minimum length: 0 Maximum length: 36 |
name |
String |
Minimum length: 0 Maximum length: 255 |
billing_info |
String |
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" } } }, { "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" } } } ], "request_id" : "db4b975a79d1da86dda3d02054f11e16" }
SDK Sample Code
The sample code is as follows:
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 |
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"); ICredential auth = new BasicCredentials() .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()); } } } |
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 |
# coding: utf-8 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.getenv("CLOUD_SDK_AK") sk = os.getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ 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) |
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 |
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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). 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) } } |
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot