Binding Global EIPs to a Connect Gateway
Function
This API is used to bind global EIPs to a connect gateway.
Calling Method
For details, see Calling APIs.
URI
POST /v3/{project_id}/dcaas/connect-gateways/{connect_gateway_id}/binding-global-eips
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
connect_gateway_id |
Yes |
String |
Specifies the connect gateway ID. |
project_id |
Yes |
String |
Specifies the project ID. Minimum: 0 Maximum: 36 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header. Minimum: 0 Maximum: 10240 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
gcb_id |
No |
String |
Specifies the global connection bandwidth ID. Minimum: 0 Maximum: 36 |
global_eips |
No |
Array of BindingGeipBody objects |
Global Eips Request Object. |
Response Parameters
Status code: 201
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Specifies the request ID. |
global_eips |
ListBindingGeip object |
Lists the global EIPs. |
Parameter |
Type |
Description |
---|---|---|
global_eip_id |
String |
Specifies the global EIP ID. |
global_eip_segment_id |
String |
Specifies the ID of the global EIP range. |
status |
String |
Specifies whether the global EIP has been bound. |
type |
String |
Specifies the global EIP type. The value can be IP_ADDRESS or IP_SEGMENT. |
error_message |
String |
Specifies the cause of the failure to bind the global EIP. |
cidr |
String |
Specifies the global EIP and its subnet mask. |
address_family |
String |
Specifies the address family of the global EIP. |
ie_vtep_ip |
String |
Specifies the VTEP IP address of the CloudPond cluster. |
created_time |
String |
Specifies the time when the global EIP was bound. |
gcb_id |
String |
Specifies the global connection bandwidth ID. |
Example Requests
Binding global EIPs to a connect gateway
POST https://{dc_endpoint}/v3/b197c48159d44a66b32c538c3f8da89a/dcaas/connect-gateways/934aa302-5f1a-44c8-855b-20f715e2dbf3/binding-global-eips { "global_eips" : [ { "global_eip_id" : "d9157a57-95f7-4183-b0d3-a3897d3587b0", "type" : "IP_SEGMENT" } ], "gcb_id" : "8a25d596-022a-4ba4-ab07-1bd14aa076b4" }
Example Responses
Status code: 201
CREATED
- The global EIPs that have been bound
{ "request_id" : "90a2730218b5f585386320973dd4ead6", "global_eips" : [ { "global_eip_id" : "d9157a57-95f7-4183-b0d3-a3897d3587b0", "status" : "BINDING", "type" : "IP_ADDRESS", "created_time" : "2024-12-11T23:19:17.000Z" } ] }
SDK Sample Code
The SDK sample code is as follows.
Binding global EIPs to a connect gateway
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 |
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.dc.v3.region.DcRegion; import com.huaweicloud.sdk.dc.v3.*; import com.huaweicloud.sdk.dc.v3.model.*; import java.util.List; import java.util.ArrayList; public class BindGlobalEipsSolution { 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); DcClient client = DcClient.newBuilder() .withCredential(auth) .withRegion(DcRegion.valueOf("<YOUR REGION>")) .build(); BindGlobalEipsRequest request = new BindGlobalEipsRequest(); request.withConnectGatewayId("{connect_gateway_id}"); CreateBindingGeipRequestBody body = new CreateBindingGeipRequestBody(); List<BindingGeipBody> listbodyGlobalEips = new ArrayList<>(); listbodyGlobalEips.add( new BindingGeipBody() .withGlobalEipId("d9157a57-95f7-4183-b0d3-a3897d3587b0") .withType(BindingGeipBody.TypeEnum.fromValue("IP_SEGMENT")) ); body.withGlobalEips(listbodyGlobalEips); body.withGcbId("8a25d596-022a-4ba4-ab07-1bd14aa076b4"); request.withBody(body); try { BindGlobalEipsResponse response = client.bindGlobalEips(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()); } } } |
Binding global EIPs to a connect gateway
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 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdc.v3.region.dc_region import DcRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdc.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 = DcClient.new_builder() \ .with_credentials(credentials) \ .with_region(DcRegion.value_of("<YOUR REGION>")) \ .build() try: request = BindGlobalEipsRequest() request.connect_gateway_id = "{connect_gateway_id}" listGlobalEipsbody = [ BindingGeipBody( global_eip_id="d9157a57-95f7-4183-b0d3-a3897d3587b0", type="IP_SEGMENT" ) ] request.body = CreateBindingGeipRequestBody( global_eips=listGlobalEipsbody, gcb_id="8a25d596-022a-4ba4-ab07-1bd14aa076b4" ) response = client.bind_global_eips(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Binding global EIPs to a connect gateway
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/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 := dc.NewDcClient( dc.DcClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.BindGlobalEipsRequest{} request.ConnectGatewayId = "{connect_gateway_id}" typeGlobalEips:= model.GetBindingGeipBodyTypeEnum().IP_SEGMENT var listGlobalEipsbody = []model.BindingGeipBody{ { GlobalEipId: "d9157a57-95f7-4183-b0d3-a3897d3587b0", Type: &typeGlobalEips, }, } gcbIdCreateBindingGeipRequestBody:= "8a25d596-022a-4ba4-ab07-1bd14aa076b4" request.Body = &model.CreateBindingGeipRequestBody{ GlobalEips: &listGlobalEipsbody, GcbId: &gcbIdCreateBindingGeipRequestBody, } response, err := client.BindGlobalEips(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Binding global EIPs to a connect gateway
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 |
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.dc.v3.region.DcRegion; import com.huaweicloud.sdk.dc.v3.*; import com.huaweicloud.sdk.dc.v3.model.*; import java.util.List; import java.util.ArrayList; public class BindGlobalEipsSolution { 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); DcClient client = DcClient.newBuilder() .withCredential(auth) .withRegion(DcRegion.valueOf("<YOUR REGION>")) .build(); BindGlobalEipsRequest request = new BindGlobalEipsRequest(); request.withConnectGatewayId("{connect_gateway_id}"); CreateBindingGeipRequestBody body = new CreateBindingGeipRequestBody(); List<BindingGeipBody> listbodyGlobalEips = new ArrayList<>(); listbodyGlobalEips.add( new BindingGeipBody() .withGlobalEipId("d9157a57-95f7-4183-b0d3-a3897d3587b0") .withType(BindingGeipBody.TypeEnum.fromValue("IP_SEGMENT")) ); body.withGlobalEips(listbodyGlobalEips); body.withGcbId("8a25d596-022a-4ba4-ab07-1bd14aa076b4"); request.withBody(body); try { BindGlobalEipsResponse response = client.bindGlobalEips(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()); } } } |
Binding global EIPs to a connect gateway
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 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdc.v3.region.dc_region import DcRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdc.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 = DcClient.new_builder() \ .with_credentials(credentials) \ .with_region(DcRegion.value_of("<YOUR REGION>")) \ .build() try: request = BindGlobalEipsRequest() request.connect_gateway_id = "{connect_gateway_id}" listGlobalEipsbody = [ BindingGeipBody( global_eip_id="d9157a57-95f7-4183-b0d3-a3897d3587b0", type="IP_SEGMENT" ) ] request.body = CreateBindingGeipRequestBody( global_eips=listGlobalEipsbody, gcb_id="8a25d596-022a-4ba4-ab07-1bd14aa076b4" ) response = client.bind_global_eips(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Binding global EIPs to a connect gateway
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/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 := dc.NewDcClient( dc.DcClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.BindGlobalEipsRequest{} request.ConnectGatewayId = "{connect_gateway_id}" typeGlobalEips:= model.GetBindingGeipBodyTypeEnum().IP_SEGMENT var listGlobalEipsbody = []model.BindingGeipBody{ { GlobalEipId: "d9157a57-95f7-4183-b0d3-a3897d3587b0", Type: &typeGlobalEips, }, } gcbIdCreateBindingGeipRequestBody:= "8a25d596-022a-4ba4-ab07-1bd14aa076b4" request.Body = &model.CreateBindingGeipRequestBody{ GlobalEips: &listGlobalEipsbody, GcbId: &gcbIdCreateBindingGeipRequestBody, } response, err := client.BindGlobalEips(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
201 |
CREATED |
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