Updating a Virtual Gateway
Function
This API is used to update a virtual gateway.
Calling Method
For details, see Calling APIs.
URI
PUT /v3/{project_id}/dcaas/virtual-gateways/{virtual_gateway_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Specifies the project ID. |
virtual_gateway_id |
Yes |
String |
Specifies the virtual gateway ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header. Minimum: 0 Maximum: 10240 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
virtual_gateway |
No |
UpdateVirtualGateway object |
Specifies the virtual gateway to be updated. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
No |
String |
Specifies the virtual gateway name. Minimum: 0 Maximum: 64 |
description |
No |
String |
Provides supplementary information about the virtual gateway. Minimum: 0 Maximum: 128 |
local_ep_group |
No |
Array of strings |
Lists the IPv4 subnets that can be accessed over the virtual gateway. Generally, the list contains the subnet CIDR blocks of the associated VPC. Array Length: 1 - 200 |
local_ep_group_ipv6 |
No |
Array of strings |
Lists the IPv6 subnets that can be accessed over the virtual gateway. Generally, the list contains the subnet CIDR blocks of the VPC. Array Length: 1 - 50 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
virtual_gateway |
VirtualGateway object |
Specifies parameters for creating a virtual gateway. |
request_id |
String |
Specifies the request ID. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Specifies the virtual gateway ID. |
vpc_id |
String |
Specifies the ID of the VPC connected by the virtual gateway. |
tenant_id |
String |
Specifies the ID of the project that the instance belongs to. Minimum: 32 Maximum: 32 |
name |
String |
Specifies the virtual gateway name. Minimum: 0 Maximum: 64 |
description |
String |
Provides supplementary information about the virtual gateway. Minimum: 0 Maximum: 128 |
type |
String |
Specifies the virtual gateway type. The value can only be default. Default: default |
local_ep_group |
Array of strings |
Specifies the IPv4 subnets connected by the virtual gateway, which is usually the CIDR blocks of a VPC. |
local_ep_group_ipv6 |
Array of strings |
Specifies the IPv6 subnets connected by the virtual gateway, which is usually the CIDR blocks of a VPC. This is a reserved field. |
admin_state_up |
Boolean |
Specifies the administrative status, which can be true or false. Default: true |
status |
String |
Specifies the virtual gateway status, which can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE. |
bgp_asn |
Integer |
Specifies the local BGP ASN of the virtual gateway. Minimum: 1 Maximum: 4294967295 |
enterprise_project_id |
String |
Specifies the ID of the enterprise project that the virtual gateway belongs to. Minimum: 36 Maximum: 36 |
device_id |
String |
Specifies the ID of the device that the virtual interface belongs to. |
redundant_device_id |
String |
Specifies the ID of the redundant device. |
public_border_group |
String |
Specifies the public border group of the AZ, indicating whether the site is a HomeZones site. |
tags |
Array of Tag objects |
Specifies the tags. Array Length: 0 - 10 |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Specifies the tag key. The key can contain a maximum of 36 Unicode characters, including letters, digits, hyphens (-), and underscores (_). Minimum: 0 Maximum: 36 |
value |
String |
Specifies the tag value. The value can contain a maximum of 43 Unicode characters, including letters, digits, hyphens (-), underscores (_), and periods (.). Minimum: 0 Maximum: 43 |
Example Requests
Updating the name and description of a virtual gateway and changing its IPv4 subnet to 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" ] } }
Example Responses
Status code: 200
OK
The virtual gateway associated with a VPC is updated.
{ "virtual_gateway" : { "id" : "20082c1b-3c99-48d8-8e8c-116af5d7e9f0", "name" : "update-vgw-c7b22", "description" : "", "tenant_id" : "0605768a3300d5762f82c01180692873", "vpc_id" : "6592c28e-95d7-4b0a-9f61-004fdf03420c", "device_id" : "26.151.63.100", "redundant_device_id" : "26.152.128.20", "type" : "default", "status" : "ACTIVE", "admin_state_up" : true, "bgp_asn" : 64512, "local_ep_group" : [ "192.168.3.0/24" ], "enterprise_project_id" : "0", "public_border_group" : "center" }, "request_id" : "765f7aaf8f2edd0e719de564ef72e2de" }
SDK Sample Code
The SDK sample code is as follows.
Updating the name and description of a virtual gateway and changing its IPv4 subnet to 192.168.3.0/24
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 |
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 UpdateVirtualGatewaySolution {
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");
ICredential auth = new BasicCredentials()
.withAk(ak)
.withSk(sk);
DcClient client = DcClient.newBuilder()
.withCredential(auth)
.withRegion(DcRegion.valueOf("cn-north-4"))
.build();
UpdateVirtualGatewayRequest request = new UpdateVirtualGatewayRequest();
UpdateVirtualGatewayRequestBody body = new UpdateVirtualGatewayRequestBody();
List<String> listVirtualGatewayLocalEpGroup = new ArrayList<>();
listVirtualGatewayLocalEpGroup.add("192.168.3.0/24");
UpdateVirtualGateway virtualGatewaybody = new UpdateVirtualGateway();
virtualGatewaybody.withName("update-vgw-c7b22")
.withDescription("")
.withLocalEpGroup(listVirtualGatewayLocalEpGroup);
body.withVirtualGateway(virtualGatewaybody);
request.withBody(body);
try {
UpdateVirtualGatewayResponse response = client.updateVirtualGateway(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());
}
}
}
|
Updating the name and description of a virtual gateway and changing its IPv4 subnet to 192.168.3.0/24
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 |
# coding: utf-8
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.getenv("CLOUD_SDK_AK")
sk = os.getenv("CLOUD_SDK_SK")
credentials = BasicCredentials(ak, sk) \
client = DcClient.new_builder() \
.with_credentials(credentials) \
.with_region(DcRegion.value_of("cn-north-4")) \
.build()
try:
request = UpdateVirtualGatewayRequest()
listLocalEpGroupVirtualGateway = [
"192.168.3.0/24"
]
virtualGatewaybody = UpdateVirtualGateway(
name="update-vgw-c7b22",
description="",
local_ep_group=listLocalEpGroupVirtualGateway
)
request.body = UpdateVirtualGatewayRequestBody(
virtual_gateway=virtualGatewaybody
)
response = client.update_virtual_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)
|
Updating the name and description of a virtual gateway and changing its IPv4 subnet to 192.168.3.0/24
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 |
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")
auth := basic.NewCredentialsBuilder().
WithAk(ak).
WithSk(sk).
Build()
client := dc.NewDcClient(
dc.DcClientBuilder().
WithRegion(region.ValueOf("cn-north-4")).
WithCredential(auth).
Build())
request := &model.UpdateVirtualGatewayRequest{}
var listLocalEpGroupVirtualGateway = []string{
"192.168.3.0/24",
}
nameVirtualGateway:= "update-vgw-c7b22"
descriptionVirtualGateway:= ""
virtualGatewaybody := &model.UpdateVirtualGateway{
Name: &nameVirtualGateway,
Description: &descriptionVirtualGateway,
LocalEpGroup: &listLocalEpGroupVirtualGateway,
}
request.Body = &model.UpdateVirtualGatewayRequestBody{
VirtualGateway: virtualGatewaybody,
}
response, err := client.UpdateVirtualGateway(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot