Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com> Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com> Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>
12 KiB
Updating a Virtual Gateway
Function
This API is used to update a virtual gateway.
URI
PUT /v2.0/dcaas/virtual-gateways/{virtual_gateway_id}
Parameter |
Type |
Mandatory |
Description |
---|---|---|---|
virtual_gateway_id |
String |
Yes |
Specifies the virtual gateway ID. |
Request
Table 2 lists the request parameter.
Parameter |
Type |
Mandatory |
Description |
---|---|---|---|
virtual_gateway |
Dictionary |
Yes |
Specifies the virtual_gateway object. |
Parameter |
Type |
Mandatory |
Description |
---|---|---|---|
description |
String |
No |
Provides supplementary information about the virtual gateway. Angle brackets (<>) are not allowed. |
name |
String |
No |
Specifies the virtual gateway name. Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed. |
local_ep_group_id |
String |
No |
Specifies the ID of the local endpoint group that records CIDR blocks of the VPC subnets. |
Response
Table 3 lists the response parameter.
Parameter |
Type |
Description |
---|---|---|
virtual_gateway |
Dictionary |
Specifies the virtual_gateway object. |
For details about the virtual_gateway field, see Table 1.
Examples
- Example request
PUT /v2.0/dcaas/virtual-gateways/{virtual_gateway_id} { "virtual_gateway" : { "name" : "virtual gateway1", "description" : "New description" } }
- Example response
{ "virtual_gateway" : { "id": "0a0888a6-4096-43a6-81c6-923912933451", "name": "virtual gateway1", "description": "New description", "tenant_id": "0605768a3300d5762f82c01180692873", "vpc_id": "5352423b-b4ff-4a9e-839d-02698c2b36af", "local_ep_group_id": "f8834cf1-5468-87c7-223d-56e78b9699ab", "local_ep_group_ipv6_id": null, "device_id": "aaa_01", "redundant_device_id": null, "type": "default", "ipsec_bandwidth": 1, "status": "PENDING_CREATE", "admin_state_up": true, "bgp_asn": null, "region_id": null } }
Status Codes
For details, see Common Status Codes.