查询专线全域接入网关详情 - ShowGlobalDcGateway
功能介绍
查询专线全域接入网关实例详情信息
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
URI
GET /v3/{project_id}/dcaas/global-dc-gateways/{global_dc_gateway_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 租户项目ID。获取方法请参见《统一身份认证服务API参考》的『获取账号项目ID』章节,或通过查询项目列表接口获取 约束限制: 不涉及 取值范围: 32 位十六进制字符(0-9, a-f, A-F) 默认取值: 不涉及 |
| global_dc_gateway_id | 是 | String | 参数解释: 全域接入网关ID 约束限制: 不涉及 取值范围: UUID 格式,以连字符(-)连接 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释: 每页返回的个数。 约束限制: 不涉及 取值范围: 1~2000。 默认取值: 2000 |
| fields | 否 | Array of strings | 参数解释: 显示字段列表,数组中每个字符串为虚拟接口对象的字段名(如 id、name、admin_state_up、bandwidth、status 等) 约束限制: 数组长度为1~5 取值范围: 不涉及 默认取值: 不涉及 |
| ext_fields | 否 | Array of strings | 参数解释: show response ext-fields 约束限制: 数组长度为0~5 |
| enterprise_project_id | 否 | Array of strings | 参数解释: 根据企业项目ID过滤资源实例。获取方式:可通过企业项目管理服务查询获取 约束限制: 数组长度为1~10 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 获取Token,请参考《统一身份认证服务API参考》的「获取用户Token」章节。请求响应成功后在响应消息头中包含的「X-Subject-Token」的值即为Token值。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| global_dc_gateway | GlobalDcGatewayEntry object | 参数解释: global-dc-gateway详情。 取值范围: 不涉及 |
| request_id | String | 参数解释: 请求ID。 取值范围: 长度不超过36个字符 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 专线全域接入网关(global-dc-gateway)ID 取值范围: 长度不超过36个字符 |
| tenant_id | String | 参数解释: 项目ID。 取值范围: 不涉及 |
| name | String | 参数解释: 全域接入网关名称。 取值范围: 长度不超过64个字符 |
| description | String | 参数解释: 描述信息 取值范围: 长度不超过128个字符 |
| reason | String | 参数解释: 失败原因 取值范围: 长度不超过255个字符 |
| enterprise_project_id | String | 参数解释: global-dc-gateway所属的企业项目ID。 取值范围: 长度不超过36个字符 |
| global_center_network_id | String | 参数解释: DGW加载的全球中心网络实例的ID 取值范围: 长度不超过36个字符 |
| bgp_asn | Long | 参数解释: DGW对应BGP的ASN编号 取值范围: 0~65535 |
| region_id | String | 参数解释: DGW所属Region 取值范围: 不涉及 |
| location_name | String | 参数解释: DGW创建网关设备归属的位置 取值范围: 长度不超过36个字符 |
| locales | LocalesBody object | 参数解释: Locale地址描述信息。 |
| current_peer_link_count | Integer | 参数解释: 全域接入网关(GDGW)上关联连接的数量,表示DGW挂载ER的数量 取值范围: 不涉及 |
| available_peer_link_count | Integer | 参数解释: 该全域接入网关上GDGW允许创建关联连接(PeerLink)的数量 取值范围: 不涉及 |
| tags | Array of Tag objects | 参数解释: global-dc-gateway关联TAG。 |
| 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双栈 取值范围: |
请求示例
查询全域接入网关详情
GET https://{dc_endpoint}/v3/b197c48159d44a66b32c538c3f8da89a/dcaas/global-dc-gateways/71f6ac9b-2745-4fb8-96c8-9d97d969c4b5 响应示例
状态码:200
全域接入网关详情查询结果
{
"global_dc_gateway" : {
"enterprise_project_id" : "0",
"name" : "dgw-2c18",
"id" : "71f6ac9b-2745-4fb8-96c8-9d97d969c4b5",
"tenant_id" : "b197c48159d44a66b32c538c3f8da89a",
"description" : "",
"tags" : [ ],
"status" : "DOWN",
"reason" : null,
"admin_state_up" : true,
"created_time" : "2024-12-12T07:33:19.000Z",
"updated_time" : "2024-12-12T07:33:19.000Z",
"bgp_asn" : 64512,
"global_center_network_id" : null,
"current_peer_link_count" : 0,
"available_peer_link_count" : 3,
"location_name" : null,
"locales" : null,
"region_id" : null,
"address_family" : "ipv4"
},
"request_id" : "e09daf2d-7689-4815-812e-bd9e12a53906"
} SDK代码示例
SDK代码示例如下。
Java
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 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 ShowGlobalDcGatewaySolution { 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(); ShowGlobalDcGatewayRequest request = new ShowGlobalDcGatewayRequest(); request.withGlobalDcGatewayId("{global_dc_gateway_id}"); try { ShowGlobalDcGatewayResponse response = client.showGlobalDcGateway(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()); } } } |
Python
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 | # 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 = ShowGlobalDcGatewayRequest() request.global_dc_gateway_id = "{global_dc_gateway_id}" response = client.show_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) |
Go
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 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := dc.DcClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dc.NewDcClient(hcClient) request := &model.ShowGlobalDcGatewayRequest{} request.GlobalDcGatewayId = "{global_dc_gateway_id}" response, err := client.ShowGlobalDcGateway(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
错误码
请参见错误码。