更新专线全域接入网关
功能介绍
更新专线全域接入网关global-dc-gateway的名字,描述等信息
调用方法
请参见如何调用API。
URI
PUT /v3/{project_id}/dcaas/global-dc-gateways/{global_dc_gateway_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户项目ID |
global_dc_gateway_id |
是 |
String |
全域接入网关ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 获取Token,请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 最小长度:0 最大长度:10240 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
否 |
String |
global-dc-gateway名字。 最小长度:0 最大长度:64 |
description |
否 |
String |
描述信息。 最小长度:0 最大长度:255 |
address_family |
否 |
String |
global-dc-gateway的地址族 最小长度:0 最大长度:36 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
专线全域接入网关(global-dc-gateway)ID 最小长度:0 最大长度:36 |
tenant_id |
String |
项目ID。 最小长度:0 最大长度:255 |
name |
String |
global-dc-gateway名字。 最小长度:0 最大长度:64 |
description |
String |
描述信息 最小长度:0 最大长度:128 |
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 |
device_id |
String |
全域接入网关(DGW)在云上的设备ID 最小长度:0 最大长度:64 |
location_name |
String |
DGW创建网关设备归属的位置 最小长度:0 最大长度:36 |
locales |
LocalesBody object |
Locale地址描述信息。 |
current_peer_link_count |
String |
全域接入网关(GDGW)上关联连接的数量,表示DGW挂载ER的数量 |
available_peer_link_count |
String |
该全域接入网关上GDGW允许创建关联连接(PeerLink)的数量 |
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双栈
|
请求示例
PUT https://{dc_endpoint}/v3/b197c48159d44a66b32c538c3f8da89a/dcaas/global-dc-gateways/71f6ac9b-2745-4fb8-96c8-9d97d969c4b5 { "global_dc_gateway": { "name": "dgw-2c19" } }
响应示例
{ "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, "site_network_id": null, "cloud_connection_id": null, "current_peer_link_count": 0, "available_peer_link_count": 3, "location_name": null, "region_id": null } }
SDK代码示例
SDK代码示例如下。
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 |
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.*; public class UpdateGlobalDcGatewaySolution { 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DcClient client = DcClient.newBuilder() .withCredential(auth) .withRegion(DcRegion.valueOf("<YOUR REGION>")) .build(); UpdateGlobalDcGatewayRequest request = new UpdateGlobalDcGatewayRequest(); request.withGlobalDcGatewayId("{global_dc_gateway_id}"); UpdateGlobalDcGatewayRequestBody body = new UpdateGlobalDcGatewayRequestBody(); request.withBody(body); try { UpdateGlobalDcGatewayResponse response = client.updateGlobalDcGateway(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()); } } } |
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 |
# coding: utf-8 import os 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.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DcClient.new_builder() \ .with_credentials(credentials) \ .with_region(DcRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateGlobalDcGatewayRequest() request.global_dc_gateway_id = "{global_dc_gateway_id}" request.body = UpdateGlobalDcGatewayRequestBody( ) response = client.update_global_dc_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) |
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 |
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") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := dc.NewDcClient( dc.DcClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateGlobalDcGatewayRequest{} request.GlobalDcGatewayId = "{global_dc_gateway_id}" request.Body = &model.UpdateGlobalDcGatewayRequestBody{ } response, err := client.UpdateGlobalDcGateway(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
错误码
请参见错误码。