文档首页/ 云专线 DC/ API参考/ API/ 全域接入网关/ 更新专线全域接入网关 - UpdateGlobalDcGateway
更新时间:2026-10-21 GMT+08:00
分享

更新专线全域接入网关 - UpdateGlobalDcGateway

功能介绍

更新专线全域接入网关的名称、描述等信息

调用方法

请参见如何调用API。

授权信息

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

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

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    dcaas:gdgw:update

    Write

    gdgw *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    -

    -

URI

PUT /v3/{project_id}/dcaas/global-dc-gateways/{global_dc_gateway_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

租户项目ID。获取方法请参见《统一身份认证服务API参考》的『获取账号项目ID』章节,或通过查询项目列表接口获取

约束限制:

不涉及

取值范围:

32 位十六进制字符(0-9, a-f, A-F)

默认取值:

不涉及

global_dc_gateway_id

是

String

参数解释:

全域接入网关ID

约束限制:

不涉及

取值范围:

UUID 格式,以连字符(-)连接

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

global_dc_gateway

是

UpdateGlobalDcGateway object

参数解释:

更新全域接入网关的属性详情。

约束限制:

不涉及

表4 UpdateGlobalDcGateway

参数

是否必选

参数类型

描述

name

否

String

参数解释:

全域接入网关名称。

约束限制:

不涉及

取值范围:

只能包含中文字符、数字(0~9)、小写字母(a~z)、大写字母(A~Z)、下划线(_)、点(.)、中划线(-),至少1个字符,长度不超过64个字符

默认取值:

不涉及

description

否

String

参数解释:

描述信息。

约束限制:

不涉及

取值范围:

只能包含除 <、> 以外的任意字符,长度不超过255个字符

默认取值:

不涉及

address_family

否

String

参数解释:

全域接入网关的地址族

约束限制:

不涉及

取值范围:

长度不超过36个字符

默认取值:

不涉及

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

global_dc_gateway

GlobalDcGatewayEntry object

参数解释:

global-dc-gateway详情。

取值范围:

不涉及

request_id

String

参数解释:

请求ID。

取值范围:

长度不超过36个字符

表6 GlobalDcGatewayEntry

参数

参数类型

描述

id

String

参数解释:

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

取值范围:

长度不超过36个字符

tenant_id

String

参数解释:

项目ID。

取值范围:

不涉及

name

String

参数解释:

全域接入网关名称。

取值范围:

长度不超过64个字符

description

String

参数解释:

描述信息

取值范围:

长度不超过128个字符

reason

String

参数解释:

失败原因

取值范围:

长度不超过255个字符

enterprise_project_id

String

参数解释:

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

取值范围:

长度不超过36个字符

global_center_network_id

String

参数解释:

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

取值范围:

长度不超过36个字符

bgp_asn

Long

参数解释:

DGW对应BGP的ASN编号

取值范围:

0~65535

region_id

String

参数解释:

DGW所属Region

取值范围:

不涉及

location_name

String

参数解释:

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

取值范围:

长度不超过36个字符

locales

LocalesBody object

参数解释:

Locale地址描述信息。

current_peer_link_count

Integer

参数解释:

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

取值范围:

不涉及

available_peer_link_count

Integer

参数解释:

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

取值范围:

不涉及

tags

Array of Tag objects

参数解释:

global-dc-gateway关联TAG。

admin_state_up

Boolean

参数解释:

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

取值范围:

  • true

  • false

status

String

参数解释:

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

取值范围:

  • DOWN

  • PENDING_UPDATE

  • ACTIVE

  • ERROR

created_time

String

参数解释:

创建时间。

updated_time

String

参数解释:

更新时间。

address_family

String

参数解释:

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

  • ipv4

  • dual

取值范围:

  • ipv4

  • dual

表7 LocalesBody

参数

参数类型

描述

en_us

String

参数解释:

区域英文名称。

取值范围:

只能包含除 <、> 以外的任意字符,长度不超过255个字符

zh_cn

String

参数解释:

区域中文名称。

取值范围:

只能包含除 <、> 以外的任意字符,长度不超过255个字符

表8 Tag

参数

参数类型

描述

key

String

参数解释:

标签键

取值范围:

取值可以包含任意语种字母、数字、空格,以及_.:=+-@特殊字符,但首尾不能含有空格,不能以_sys_开头;长度为1~128个字符

value

String

参数解释:

标签值

取值范围:

可以包含任意语种字母、数字、空格,以及_.:/=+-@特殊字符;长度不超过255个字符

请求示例

全域接入网关更新请求体

PUT https://{dc_endpoint}/v3/b197c48159d44a66b32c538c3f8da89a/dcaas/global-dc-gateways/71f6ac9b-2745-4fb8-96c8-9d97d969c4b5

{
  "global_dc_gateway" : {
    "name" : "dgw-2c19"
  }
}

响应示例

状态码:200

全域接入网关更新返回体

{
  "request_id" : "fa70b8d1f22787684bba9407779b8bf2",
  "global_dc_gateway" : {
    "enterprise_project_id" : "0",
    "name" : "dgw-2c19",
    "id" : "71f6ac9b-2745-4fb8-96c8-9d97d969c4b5",
    "tenant_id" : "b197c48159d44a66b32c538c3f8da89a",
    "description" : "",
    "status" : "DOWN",
    "admin_state_up" : true,
    "created_time" : "2024-12-12T07:33:19.000Z",
    "updated_time" : "2024-12-12T07:36:04.257Z",
    "bgp_asn" : 64512,
    "global_center_network_id" : null,
    "current_peer_link_count" : 0,
    "available_peer_link_count" : 3,
    "location_name" : null,
    "region_id" : null
  }
}

SDK代码示例

SDK代码示例如下。

Java

全域接入网关更新请求体

 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
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.*;


public class UpdateGlobalDcGatewaySolution {

    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();
        UpdateGlobalDcGatewayRequest request = new UpdateGlobalDcGatewayRequest();
        request.withGlobalDcGatewayId("{global_dc_gateway_id}");
        UpdateGlobalDcGatewayRequestBody body = new UpdateGlobalDcGatewayRequestBody();
        UpdateGlobalDcGateway globalDcGatewaybody = new UpdateGlobalDcGateway();
        globalDcGatewaybody.withName("dgw-2c19");
        body.withGlobalDcGateway(globalDcGatewaybody);
        request.withBody(body);
        try {
            UpdateGlobalDcGatewayResponse response = client.updateGlobalDcGateway(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

全域接入网关更新请求体

 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
# 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 = UpdateGlobalDcGatewayRequest()
        request.global_dc_gateway_id = "{global_dc_gateway_id}"
        globalDcGatewaybody = UpdateGlobalDcGateway(
            name="dgw-2c19"
        )
        request.body = UpdateGlobalDcGatewayRequestBody(
            global_dc_gateway=globalDcGatewaybody
        )
        response = client.update_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)

Go

全域接入网关更新请求体

 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
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, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := dc.DcClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := dc.NewDcClient(hcClient)

    request := &model.UpdateGlobalDcGatewayRequest{}
	request.GlobalDcGatewayId = "{global_dc_gateway_id}"
	nameGlobalDcGateway:= "dgw-2c19"
	globalDcGatewaybody := &model.UpdateGlobalDcGateway{
		Name: &nameGlobalDcGateway,
	}
	request.Body = &model.UpdateGlobalDcGatewayRequestBody{
		GlobalDcGateway: globalDcGatewaybody,
	}
	response, err := client.UpdateGlobalDcGateway(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

OK

错误码

请参见错误码。

相关文档