Updating a Site Network
Function
This API is used to update a site network.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
PUT /v3/{domain_id}/dcaas/site-networks/{site_network_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_id |
Yes |
String |
Account ID. |
site_network_id |
Yes |
String |
Site network ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
User token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
site_network |
Yes |
UpdateSiteNetwork object |
Details of the site network to be updated. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
No |
String |
Instance name. |
description |
No |
String |
Resource description. Angle brackets (<>) are not allowed. |
tags |
No |
Array of Tag objects |
Resource tags. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
key |
Yes |
String |
Tag key. The key can contain a maximum of 128 Unicode characters, including letters, digits, hyphens (-), and underscores (_). |
value |
No |
String |
Tag value. The value can contain a maximum of 255 Unicode characters, including letters, digits, hyphens (-), underscores (_), and periods (.). |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Request ID. |
site_network |
SiteNetworkEntry object |
Site network. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Instance ID. |
name |
String |
Instance name. |
description |
String |
Resource description. Angle brackets (<>) are not allowed. |
created_at |
String |
Time when the resource was created. The time is in the yyyy-MM-ddTHH:mm:ss format. |
updated_at |
String |
Time when the resource was updated. The time must be in the yyyy-MM-ddTHH:mm:ss format. |
domain_id |
String |
ID of the account that the instance belongs to. |
state |
String |
Site network status.
|
enterprise_project_id |
String |
ID of the enterprise project that the resource belongs to. |
apply_policy_id |
String |
Policy ID. |
tags |
Array of Tag objects |
Resource tags. |
topology |
String |
Site network topology.
|
connections |
Array of SiteConnection objects |
List of site-to-site connections. |
sites |
Array of SiteInformation objects |
A node in a point-to-point or mesh topology. |
hub_site |
SiteInformation object |
Site information. |
spoke_sites |
Array of SiteInformation objects |
Site list. |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Tag key. The key can contain a maximum of 128 Unicode characters, including letters, digits, hyphens (-), and underscores (_). |
value |
String |
Tag value. The value can contain a maximum of 255 Unicode characters, including letters, digits, hyphens (-), underscores (_), and periods (.). |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Instance ID. |
site_network_id |
String |
Site network ID. |
state |
String |
Site-to-site connection status.
|
created_at |
String |
Time when the resource was created. The time is in the yyyy-MM-ddTHH:mm:ss format. |
updated_at |
String |
Time when the resource was updated. The time must be in the yyyy-MM-ddTHH:mm:ss format. |
edge_pair |
Array of DirectedEdge objects |
Definition of the two ends of a site-to-site connection. The length is fixed to an array of 2. |
cross_region_type |
String |
Communications within a region or between regions.
|
global_connection_bandwidth_id |
String |
Global connection bandwidth ID. |
bandwidth_size |
Integer |
Amount of bandwidth, in Mbit/s. |
is_frozen |
Boolean |
Whether the resource is frozen. |
frozen_effect |
String |
Resource frozen effect.
|
is_bind_bandwidth |
Boolean |
Whether a bandwidth package is bound. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Instance ID. |
region_id |
String |
Region ID. |
gateway_id |
String |
Gateway ID. |
gateway_type |
String |
Gateway type. GDGW indicates global DC gateways. |
site_code |
String |
Site code. |
project_id |
String |
Project ID. |
Parameter |
Type |
Description |
---|---|---|
region_id |
String |
Region ID. |
project_id |
String |
Project ID. |
gateway_type |
String |
Gateway type. GDGW indicates global DC gateways. |
gateway_id |
String |
Gateway ID. |
site_code |
String |
Site code. |
asn |
Long |
ASN of the network instance when BGP is used for routing. |
Example Requests
Updating a site network
PUT /v3/{domain_id}/dcaas/site-networks/{site_network_id} { "site_network" : { "name" : "name" } }
Example Responses
Status code: 200
The site network has been updated.
{ "request_id" : "0050ea65af7e190d9a791d9e69f28e63", "site_network" : { "id" : "eb350a5c-06c1-4b12-9ae4-3820f31faaa0", "name" : "er-connection", "domain_id" : "XXX", "created_at" : "2023-10-09T10:15:32.134Z", "updated_at" : "2023-10-09T10:15:32.134Z", "enterprise_project_id" : "0", "apply_policy_id" : "43ad756e-2780-463e-a8ed-27a5bd77b7a7", "topology" : "p2p", "state" : "AVAILABLE", "sites" : [ { "gateway_id" : "1c233723-234c-4b50-8fba-7072b4c6aa1a", "project_id" : "XXX", "region_id" : "region-abc", "site_code" : "region-abc", "gateway_type" : "GDGW" }, { "gateway_id" : "8641d7f0-bd0c-49fe-8b70-3649cd7dd9b1", "project_id" : "XXX", "region_id" : "region-abc", "site_code" : "region-abc", "gateway_type" : "GDGW" } ], "connections" : [ { "id" : "1c233723-234c-4b50-8fba-7072b4c6aa1a", "state" : "AVAILABLE", "cross_region_type" : "inter-region", "global_connection_bandwidth_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", "bandwidth_size" : 20, "is_frozen" : false, "is_bind_bandwidth" : false, "edge_pair" : [ { "id" : "1c233723-234c-4b50-8fba-7072b4c6aa1a", "gateway_id" : "8641d7f0-bd0c-49fe-8b70-3649cd7dd9b1", "project_id" : "XXX", "region_id" : "region-abc", "site_code" : "region-abc", "gateway_type" : "GDGW" }, { "id" : "1c233723-234c-4b50-8fba-7072b4c6aa11", "gateway_id" : "8641d7f0-bd0c-49fe-8b70-3649cd7dd9b1", "project_id" : "XXX", "region_id" : "region-abc", "site_code" : "region-abc", "gateway_type" : "GDGW" } ] } ] } }
SDK Sample Code
The SDK sample code is as follows.
Updating a site network
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 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.GlobalCredentials; 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.cc.v3.region.CcRegion; import com.huaweicloud.sdk.cc.v3.*; import com.huaweicloud.sdk.cc.v3.model.*; public class UpdateSiteNetworkSolution { 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 GlobalCredentials() .withAk(ak) .withSk(sk); CcClient client = CcClient.newBuilder() .withCredential(auth) .withRegion(CcRegion.valueOf("<YOUR REGION>")) .build(); UpdateSiteNetworkRequest request = new UpdateSiteNetworkRequest(); request.withSiteNetworkId("{site_network_id}"); UpdateSiteNetworkRequestBody body = new UpdateSiteNetworkRequestBody(); UpdateSiteNetwork siteNetworkbody = new UpdateSiteNetwork(); siteNetworkbody.withName("name"); body.withSiteNetwork(siteNetworkbody); request.withBody(body); try { UpdateSiteNetworkResponse response = client.updateSiteNetwork(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 a site network
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdkcc.v3.region.cc_region import CcRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcc.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"] credentials = GlobalCredentials(ak, sk) client = CcClient.new_builder() \ .with_credentials(credentials) \ .with_region(CcRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateSiteNetworkRequest() request.site_network_id = "{site_network_id}" siteNetworkbody = UpdateSiteNetwork( name="name" ) request.body = UpdateSiteNetworkRequestBody( site_network=siteNetworkbody ) response = client.update_site_network(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 a site network
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" cc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/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 := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := cc.NewCcClient( cc.CcClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateSiteNetworkRequest{} request.SiteNetworkId = "{site_network_id}" nameSiteNetwork:= "name" siteNetworkbody := &model.UpdateSiteNetwork{ Name: &nameSiteNetwork, } request.Body = &model.UpdateSiteNetworkRequestBody{ SiteNetwork: siteNetworkbody, } response, err := client.UpdateSiteNetwork(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 |
The site network has been updated. |
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