文档首页/ 云专线 DC/ API参考 (联盟区域) / API/ 全域接入网关/ 更新专线全域接入网关
更新时间：2026-01-08 GMT+08:00
在线调试
CLI示例
查看PDF
分享

更新专线全域接入网关

功能介绍

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

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户项目ID

最小长度：0

最大长度：36

global_dc_gateway_id

是

String

全域接入网关ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

最小长度：0

最大长度：10240
表3 请求Body参数

参数

是否必选

参数类型

描述

global_dc_gateway

是

UpdateGlobalDcGateway object

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

参数

是否必选

参数类型

描述

name

否

String

全域接入网关名称。

最小长度：0

最大长度：64

description

否

String

描述信息。

最小长度：0

最大长度：255

address_family

否

String

全域接入网关的地址族

最小长度：0

最大长度：36

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

global_dc_gateway

GlobalDcGatewayEntry object

global-dc-gateway详情。

request_id

String

请求ID。

最小长度：0

最大长度：36
表6 GlobalDcGatewayEntry

参数

参数类型

描述

id

String

专线全域接入网关（global-dc-gateway）ID

最小长度：0

最大长度：36

tenant_id

String

项目ID。

最小长度：0

最大长度：255

name

String

全域接入网关名称。

最小长度：0

最大长度：64

description

String

描述信息

最小长度：0

最大长度：128

reason

String

失败原因

最小长度：0

最大长度：255

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

locales

LocalesBody object

Locale地址描述信息。

current_peer_link_count

Integer

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

available_peer_link_count

Integer

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

switchover_group_id

String

DGW归属的快速倒换组id

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

创建时间。

updated_time

String

更新时间。

address_family

String

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

  • ipv4

  • dual
表7 LocalesBody

参数

参数类型

描述

en_us

String

区域英文名称。

最小长度：0

最大长度：255

zh_cn

String

区域中文名称。

最小长度：0

最大长度：255
表8 Tag

参数

参数类型

描述

key

String

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

最小长度：1

最大长度：128

value

String

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

最小长度：0

最大长度：255

请求示例

全域接入网关更新请求体

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

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

响应示例

状态码：200

OK

全域接入网关更新返回体

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

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 全域接入网关