文档首页/ 云专线 DC/ API参考/ API/ 全域接入网关/ 创建专线全域接入网关 - CreateGlobalDcGateway
更新时间:2025-10-28 GMT+08:00

创建专线全域接入网关 - CreateGlobalDcGateway

功能介绍

创建专线全域接入网关实例(global-dc-gateway),用于接入全球的ER实例

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    dcaas:gdgw:create

    Write

    gdgw *

    -

    -

    -

    -

    • g:EnterpriseProjectId

    • g:RequestTag/<tag-key>

    • g:TagKeys

URI

POST /v3/{project_id}/dcaas/global-dc-gateways

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户项目ID

最小长度:0

最大长度:36

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 获取Token,请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

最小长度:0

最大长度:10240

表3 请求Body参数

参数

是否必选

参数类型

描述

global_dc_gateway

CreateGlobalDcGateway object

创建global-dc-gateway的属性详情。

表4 CreateGlobalDcGateway

参数

是否必选

参数类型

描述

tenant_id

String

项目ID。

最小长度:0

最大长度:255

name

String

global-dc-gateway名字。

最小长度:0

最大长度:64

description

String

描述信息。

最小长度:0

最大长度:255

bgp_asn

Long

global-dc-gateway对应的ASN号

最小值:1

最大值:4294967295

enterprise_project_id

String

global-dc-gateway所属的企业项目ID。

缺省值:0

最小长度:0

最大长度:36

address_family

String

网关的地址簇,IPv4或者ipv6和IPv4双栈

  • ipv4

  • dual

tags

Array of Tag objects

global-dc-gateway关联TAG。

数组长度:0 - 10

表5 Tag

参数

是否必选

参数类型

描述

key

String

标签键,取值可以包含任意语种字母、数字、空格,以及_.:=+-@特殊字符,但首尾不能含有空格,不能以_sys_开头。

最小长度:1

最大长度:128

value

String

标签值,格式为取值可以包含任意语种字母、数字、空格,以及_.:/=+-@特殊字符。

最小长度:0

最大长度:255

响应参数

状态码:201

表6 响应Body参数

参数

参数类型

描述

global_dc_gateway

CreateGlobalDcGatewayEntry object

global-dc-gateway详情。

request_id

String

请求ID。

最小长度:0

最大长度:36

表7 CreateGlobalDcGatewayEntry

参数

参数类型

描述

id

String

专线全域接入网关(global-dc-gateway)ID

最小长度:0

最大长度:36

tenant_id

String

项目ID。

最小长度:0

最大长度:255

name

String

global-dc-gateway名字。

最小长度:0

最大长度:64

description

String

描述信息

最小长度:0

最大长度:128

enterprise_project_id

String

global-dc-gateway所属的企业项目ID。

最小长度:0

最大长度:36

global_center_network_id

String

DGW加载的全球中心网络实例的ID

最小长度:0

最大长度:36

bgp_asn

Long

DGW对应BGP的ASN编号

最小值:0

最大值:65535

region_id

String

DGW所属Region

最小长度:0

最大长度:36

location_name

String

DGW创建网关设备归属的位置

最小长度:0

最大长度:36

current_peer_link_count

Integer

全域接入网关(GDGW)上关联连接的数量,表示DGW挂载ER的数量

available_peer_link_count

Integer

该全域接入网关上GDGW允许创建关联连接(PeerLink)的数量

tags

Array of Tag objects

global-dc-gateway关联TAG。

数组长度:0 - 10

admin_state_up

Boolean

该GDGW的管理状态,true为激活状态、false为冻结状态

status

String

GDGW资源状态,DOWN (未连接状态), PENDING_UPDATE(连接状态更新中),ACTIVE (已连接状态), ERROR (出错)。

created_time

String

创建时间。

address_family

String

网关的地址簇,IPv4或者ipv6和IPv4双栈

  • ipv4

  • dual

表8 Tag

参数

参数类型

描述

key

String

标签键,取值可以包含任意语种字母、数字、空格,以及_.:=+-@特殊字符,但首尾不能含有空格,不能以_sys_开头。

最小长度:1

最大长度:128

value

String

标签值,格式为取值可以包含任意语种字母、数字、空格,以及_.:/=+-@特殊字符。

最小长度:0

最大长度:255

请求示例

全域接入网关创建请求体

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"
  }
}

响应示例

状态码:201

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代码示例

SDK代码示例如下。

全域接入网关创建请求体

 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());
        }
    }
}

全域接入网关创建请求体

 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)

全域接入网关创建请求体

 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)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

201

Created

错误码

请参见错误码