功能介绍
更新虚拟网关的信息
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
PUT /v3/{project_id}/dcaas/virtual-gateways/{virtual_gateway_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户项目ID |
virtual_gateway_id |
是 |
String |
虚拟网关ID |
请求参数
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
虚拟网关的ID |
vpc_id |
String |
虚拟网关接入的VPC的ID |
tenant_id |
String |
实例所属项目ID。 最小长度:32 最大长度:32 |
name |
String |
虚拟网关的名字 最小长度:0 最大长度:64 |
description |
String |
虚拟网关的描述 最小长度:0 最大长度:128 |
type |
String |
虚拟网关类型:default 缺省值:default |
local_ep_group |
Array of strings |
虚拟网关到访问云上服务IPv4子网列表,通常是vpc的cidrs |
local_ep_group_ipv6 |
Array of strings |
预留字段用于虚拟网关到访问云上服务IPv6子网列表,通常是vpc的cidrs |
admin_state_up |
Boolean |
管理状态:true或false 缺省值:true |
status |
String |
操作状态,合法值是:ACTIVE,DOWN,BUILD,ERROR,PENDING_CREATE,PENDING_UPDATE,PENDING_DELETE |
bgp_asn |
Integer |
虚拟网关本地的BGP自冶域号(asn) 最小值:1 最大值:4294967295 |
enterprise_project_id |
String |
实例所属企业项目ID 最小长度:36 最大长度:36 |
tags |
标签信息 数组长度:0 - 10 |
请求示例
更新虚拟网关名称和描述,将虚拟网关访问云上服务IPv4子网列表修改为192.168.3.0/24。
PUT https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-gateways/
20082c1b-3c99-48d8-8e8c-116af5d7e9f0
{
"virtual_gateway" : {
"name" : "update-vgw-c7b22",
"description" : "",
"local_ep_group" : [ "192.168.3.0/24" ]
}
}
响应示例
状态码: 200
OK
{
"virtual_gateway" : {
"id" : "20082c1b-3c99-48d8-8e8c-116af5d7e9f0",
"name" : "update-vgw-c7b22",
"description" : "",
"tenant_id" : "0605768a3300d5762f82c01180692873",
"vpc_id" : "6592c28e-95d7-4b0a-9f61-004fdf03420c",
"type" : "default",
"status" : "ACTIVE",
"admin_state_up" : true,
"bgp_asn" : 64512,
"local_ep_group" : [ "192.168.3.0/24" ],
"enterprise_project_id" : "0"
},
"request_id" : "765f7aaf8f2edd0e719de564ef72e2de"
}
状态码
状态码 |
描述 |
---|---|
200 |
OK |
错误码
请参见错误码。