查询专线关联连接列表
功能介绍
查询全域接入网关与ER等对象的关联连接列表,分页查询使用的参数为marker、limit。marker和limit一起使用时才会生效,单独使用无效
调用方法
请参见如何调用API。
URI
GET /v3/{project_id}/dcaas/global-dc-gateways/{global_dc_gateway_id}/peer-links
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户项目ID |
global_dc_gateway_id |
是 |
String |
全域接入网关ID |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
否 |
Integer |
每页返回的个数。 取值范围:1~2000。 最小值:1 最大值:2000 缺省值:2000 |
marker |
否 |
String |
上一页最后一条资源记录的ID,为空时为查询第一页。 使用说明:必须与limit一起使用。 最小长度:0 最大长度:36 |
sort_key |
否 |
String |
排序字段。 缺省值:id 最小长度:0 最大长度:36 |
sort_dir |
否 |
Array of strings |
返回结果按照升序(asc)或降序(desc)排列,默认为asc |
id |
否 |
Array of strings |
根据资源ID过滤实例 数组长度:1 - 5 |
name |
否 |
Array of strings |
根据名字过滤查询,可查询多个名字。 数组长度:1 - 5 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 获取Token,请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 最小长度:0 最大长度:10240 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
peer link ID。 最小长度:0 最大长度:36 |
tenant_id |
String |
租户项目ID 最小长度:0 最大长度:255 |
name |
String |
专线内部连接(peer link)名字 最小长度:0 最大长度:64 |
description |
String |
描述信息 最小长度:0 最大长度:255 |
global_dc_gateway_id |
String |
对应的专线全域接入网关ID 最小长度:0 最大长度:64 |
bandwidth_info |
BandWidthInfo object |
带宽信息 |
peer_site |
PeerSite object |
对端的网关的描述信息 |
status |
String |
关联连接状态,PENDING_CREATE (创建中), PENDING_UPDATE (更新中), ACTIVE (可用状态), ERROR (失败状态)。 |
created_time |
String |
创建时间。 |
updated_time |
String |
更新时间。 |
参数 |
参数类型 |
描述 |
---|---|---|
bandwidth_size |
Integer |
带宽值 最小值:0 最大值:268435455 |
gcb_id |
String |
购买全域互连带宽包ID 最小长度:0 最大长度:36 |
参数 |
参数类型 |
描述 |
---|---|---|
gateway_id |
String |
对端网关的ID 最小长度:0 最大长度:36 |
link_id |
String |
对端网关连接的ID(如:对端为ER时为attachment ID,对端为GDGW时为对端的PeerLink Id) 最小长度:0 最大长度:64 |
region_id |
String |
对端网关所在的Region 最小长度:0 最大长度:36 |
site_code |
String |
专线全域接入网关对应的站点位置 最小长度:0 最大长度:64 |
参数 |
参数类型 |
描述 |
---|---|---|
previous_marker |
String |
上一页的marker,值为资源的uuid 最小长度:0 最大长度:36 |
current_count |
Integer |
当前列表中资源数量 最小值:0 最大值:2000 |
next_marker |
String |
下一页的marker,值为资源的uuid,为空时表示最后一页 最小长度:0 最大长度:36 |
请求示例
GET https://{dc_endpoint}/v3/b197c48159d44a66b32c538c3f8da89a/dcaas/global-dc-gateways/1c6edc27-5fdb-4dae-ac77-72d47c70ed83/peer-links
响应示例
{ "request_id": "d6f35fa3bde2e26efad6253bd32b4837", "peer_links": [ { "name": "dgw-zss-02_1_peer_link", "id": "5ad07c58-71a8-41b7-a5c0-5b6148d518b2", "tenant_id": "b197c48159d44a66b32c538c3f8da89a", "description": "", "reason": null, "status": "ACTIVE", "created_time": "2024-06-21T01:48:57.000Z", "updated_time": "2024-11-17T08:44:18.504Z", "global_dc_gateway_id": "1c6edc27-5fdb-4dae-ac77-72d47c70ed83", "bandwidth_info": { "bandwidth_size": 0, "gcb_id": null }, "peer_site": { "gateway_id": "f8551651-0f42-48ff-9088-fff87e6d74e2", "link_id": "c794a0f3-e89d-4e64-a614-9b6be4394b07", "region_id": "cn-southwest-246", "site_code": "cn-southwest-246", "project_id": "6bea6e6ed6b34892bd2e195cad496348", "type": "ER" }, "create_owner": "cc", "instance_id": "f174fa3e-d63a-45bb-a5a4-b56782552494" } ] }
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 |
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 ListPeerLinksSolution { 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(); ListPeerLinksRequest request = new ListPeerLinksRequest(); request.withGlobalDcGatewayId("{global_dc_gateway_id}"); try { ListPeerLinksResponse response = client.listPeerLinks(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 |
# 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 = ListPeerLinksRequest() request.global_dc_gateway_id = "{global_dc_gateway_id}" response = client.list_peer_links(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 |
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.ListPeerLinksRequest{} request.GlobalDcGatewayId = "{global_dc_gateway_id}" response, err := client.ListPeerLinks(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
错误码
请参见错误码。