Creating a Global DC Gateway
Function
This API is used to create a global DC gateway that can be attached to an enterprise router.
Calling Method
For details, see Calling APIs.
URI
POST /v3/{project_id}/dcaas/global-dc-gateways
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
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 |
---|---|---|---|
global_dc_gateway |
Yes |
CreateGlobalDcGateway object |
Specifies the global DC gateway to be created. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
tenant_id |
No |
String |
Specifies the tenant ID. Minimum: 0 Maximum: 255 |
name |
Yes |
String |
Specifies the name of the global DC gateway. Minimum: 0 Maximum: 64 |
description |
No |
String |
Provides supplementary information about the global DC gateway. Minimum: 0 Maximum: 255 |
bgp_asn |
No |
Long |
Specifies the ASN assigned to the global DC gateway. Minimum: 1 Maximum: 4294967295 |
enterprise_project_id |
No |
String |
Specifies the ID of the enterprise project that the global DC gateway belongs to. Default: 0 Minimum: 0 Maximum: 36 |
address_family |
No |
String |
Specifies the IP address family of the global DC gateway.
|
tags |
No |
Array of Tag objects |
Specifies the tag added to the global DC gateway. Array Length: 0 - 10 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
key |
Yes |
String |
Specifies the tag key. The key can contain a maximum of 36 Unicode characters, including letters, digits, hyphens (-), and underscores (_). Minimum: 0 Maximum: 36 |
value |
No |
String |
Specifies the tag value. The value can contain a maximum of 43 Unicode characters, including letters, digits, hyphens (-), underscores (_), and periods (.). Minimum: 0 Maximum: 43 |
Response Parameters
Status code: 201
Parameter |
Type |
Description |
---|---|---|
global_dc_gateway |
CreateGlobalDcGatewayEntry object |
Specifies the global DC gateway. |
request_id |
String |
Specifies the request ID. Minimum: 0 Maximum: 36 |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Specifies the global DC gateway ID. Minimum: 0 Maximum: 36 |
tenant_id |
String |
Specifies the project ID. Minimum: 0 Maximum: 255 |
name |
String |
Specifies the name of the global DC gateway. Minimum: 0 Maximum: 64 |
description |
String |
Provides supplementary information about the global DC gateway. Minimum: 0 Maximum: 128 |
enterprise_project_id |
String |
Specifies the ID of the enterprise project that the global DC gateway belongs to. Minimum: 0 Maximum: 36 |
global_center_network_id |
String |
Specifies the ID of the central network that the global DC gateway is added to. Minimum: 0 Maximum: 36 |
bgp_asn |
Long |
Specifies the BGP ASN of the global DC gateway. Minimum: 0 Maximum: 65535 |
region_id |
String |
Specifies the region of the global DC gateway. Minimum: 0 Maximum: 36 |
location_name |
String |
Specifies the location of the global DC gateway. Minimum: 0 Maximum: 36 |
current_peer_link_count |
Integer |
Specifies the number of peer links allowed on a global DC gateway, indicating the number of enterprise routers that the global DC gateway can be attached to. |
available_peer_link_count |
Integer |
Specifies the number of peer links that can be created for a global DC gateway. |
tags |
Array of Tag objects |
Specifies the tag added to the global DC gateway. Array Length: 0 - 10 |
admin_state_up |
Boolean |
Specifies the administrative status of the global DC gateway.
|
status |
String |
Specifies the status of the global DC gateway.- DOWN: The global DC gateway is faulty.- PENDING_UPDATE: The global DC gateway is being updated.- ACTIVE: The global DC gateway is available.- ERROR: An error occurred. |
created_time |
String |
Specifies the time when the global DC gateway was created. |
address_family |
String |
Specifies the IP address family of the global DC gateway.
|
Parameter |
Type |
Description |
---|---|---|
key |
String |
Specifies the tag key. The key can contain a maximum of 36 Unicode characters, including letters, digits, hyphens (-), and underscores (_). Minimum: 0 Maximum: 36 |
value |
String |
Specifies the tag value. The value can contain a maximum of 43 Unicode characters, including letters, digits, hyphens (-), underscores (_), and periods (.). Minimum: 0 Maximum: 43 |
Example Requests
Creating a global DC gateway
POST https://{dc_endpoint}/v3/b197c48159d44a66b32c538c3f8da89a/dcaas/global-dc-gateways { "global_dc_gateway" : { "bgp_asn" : "64512", "description" : "", "enterprise_project_id" : "0", "name" : "dgw-2c18", "tags" : [ { "key" : "key1", "value" : "value1" } ], "address_family" : "ipv4" } }
Example Responses
Status code: 201
Created
- Global DC gateway that has been created
{ "request_id" : "2e97ccd07037d0f48abc620979b65976", "global_dc_gateway" : { "enterprise_project_id" : "0", "name" : "dgw-2c18", "id" : "71f6ac9b-2745-4fb8-96c8-9d97d969c4b5", "tenant_id" : "b197c48159d44a66b32c538c3f8da89a", "description" : "", "status" : "DOWN", "tags" : [ { "key" : "key1", "value" : "value1" } ], "admin_state_up" : true, "created_time" : "2024-12-11T23:33:19.000Z", "bgp_asn" : 64512, "global_center_network_id" : null, "current_peer_link_count" : null, "available_peer_link_count" : 3, "location_name" : null, "region_id" : null, "address_family" : "ipv4" } }
SDK Sample Code
The SDK sample code is as follows.
Creating a global DC 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 61 62 63 64 65 |
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 CreateGlobalDcGatewaySolution { 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(); CreateGlobalDcGatewayRequest request = new CreateGlobalDcGatewayRequest(); CreateGlobalDcGatewayRequestBody body = new CreateGlobalDcGatewayRequestBody(); List<Tag> listGlobalDcGatewayTags = new ArrayList<>(); listGlobalDcGatewayTags.add( new Tag() .withKey("key1") .withValue("value1") ); CreateGlobalDcGateway globalDcGatewaybody = new CreateGlobalDcGateway(); globalDcGatewaybody.withName("dgw-2c18") .withDescription("") .withBgpAsn(64512L) .withEnterpriseProjectId("0") .withAddressFamily(CreateGlobalDcGateway.AddressFamilyEnum.fromValue("ipv4")) .withTags(listGlobalDcGatewayTags); body.withGlobalDcGateway(globalDcGatewaybody); request.withBody(body); try { CreateGlobalDcGatewayResponse response = client.createGlobalDcGateway(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()); } } } |
Creating a global DC 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 |
# 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 = CreateGlobalDcGatewayRequest() listTagsGlobalDcGateway = [ Tag( key="key1", value="value1" ) ] globalDcGatewaybody = CreateGlobalDcGateway( name="dgw-2c18", description="", bgp_asn=64512, enterprise_project_id="0", address_family="ipv4", tags=listTagsGlobalDcGateway ) request.body = CreateGlobalDcGatewayRequestBody( global_dc_gateway=globalDcGatewaybody ) response = client.create_global_dc_gateway(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Creating a global DC 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 |
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.CreateGlobalDcGatewayRequest{} valueTags:= "value1" var listTagsGlobalDcGateway = []model.Tag{ { Key: "key1", Value: &valueTags, }, } descriptionGlobalDcGateway:= "" bgpAsnGlobalDcGateway:= int64(64512) enterpriseProjectIdGlobalDcGateway:= "0" addressFamilyGlobalDcGateway:= model.GetCreateGlobalDcGatewayAddressFamilyEnum().IPV4 globalDcGatewaybody := &model.CreateGlobalDcGateway{ Name: "dgw-2c18", Description: &descriptionGlobalDcGateway, BgpAsn: &bgpAsnGlobalDcGateway, EnterpriseProjectId: &enterpriseProjectIdGlobalDcGateway, AddressFamily: &addressFamilyGlobalDcGateway, Tags: &listTagsGlobalDcGateway, } request.Body = &model.CreateGlobalDcGatewayRequestBody{ GlobalDcGateway: globalDcGatewaybody, } response, err := client.CreateGlobalDcGateway(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