Querying the Peer Link List
Function
This API is used to query the peer link list. The marker and limit parameters are used for pagination query. The two parameters take effect only when they are used together.
Calling Method
For details, see Calling APIs.
URI
GET /v3/{project_id}/dcaas/global-dc-gateways/{global_dc_gateway_id}/peer-links
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Specifies the project ID. Minimum: 0 Maximum: 36 |
global_dc_gateway_id |
Yes |
String |
Specifies the global DC gateway ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
Integer |
Specifies the number of records returned on each page. Value range: 1 to 2000 Minimum: 1 Maximum: 2000 Default: 2000 |
offset |
No |
Integer |
Specifies the pagination offset. Minimum: 1 Maximum: 1000 |
marker |
No |
String |
Specifies the ID of the last resource record on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit. Minimum: 0 Maximum: 36 |
page_reverse |
No |
Boolean |
Specifies the pagination parameter. |
fields |
No |
Array of strings |
Specifies the list of fields to be displayed. Array Length: 1 - 5 |
ext_fields |
No |
Array of strings |
show response ext-fields Array Length: 0 - 5 |
sort_key |
No |
String |
Specifies the sorting field. Default: id Minimum: 0 Maximum: 36 |
sort_dir |
No |
Array of strings |
Specifies the sorting order of returned results. There are two options: asc (default) and desc. |
id |
No |
Array of strings |
Specifies the resource ID for querying instances. Array Length: 1 - 5 |
name |
No |
Array of strings |
Specifies the resource name for querying instances. You can specify multiple names. Array Length: 1 - 5 |
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 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
peer_links |
Array of PeerLinkEntry objects |
Lists the peer links. Array Length: 0 - 2000 |
page_info |
PageInfo object |
Specifies the pagination query information. |
request_id |
String |
Specifies the request ID. Minimum: 0 Maximum: 36 |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Specifies the peer link ID. Minimum: 0 Maximum: 36 |
tenant_id |
String |
Specifies the tenant ID. Minimum: 0 Maximum: 255 |
name |
String |
Specifies the name of the peer link. Minimum: 0 Maximum: 64 |
description |
String |
Provides supplementary information about the peer link. Minimum: 0 Maximum: 255 |
reason |
String |
Fail Resaon. Minimum: 0 Maximum: 255 |
global_dc_gateway_id |
String |
Specifies the ID of the global DC gateway that the peer link is added for. Minimum: 0 Maximum: 64 |
bandwidth_info |
BandWidthInfo object |
Provides bandwidth information. |
peer_site |
PeerSite object |
Describes the peer site. |
status |
String |
Specifies the status of the peer link.- PENDING_CREATE: The peer link is being created.- PENDING_UPDATE: The peer link is being updated.- ACTIVE: The peer link is available.- ERROR: An error occurred. |
created_time |
String |
Specifies the time when the peer link was added. |
updated_time |
String |
Specifies the time when the peer link was updated. |
create_owner |
String |
Specifies the cloud service where the peer link is used.
|
instance_id |
String |
Specifies the ID of the instance associated with the peer link. |
Parameter |
Type |
Description |
---|---|---|
bandwidth_size |
Integer |
Specifies the bandwidth. Minimum: 0 Maximum: 268435455 |
gcb_id |
String |
Specifies the global connection bandwidth ID. Minimum: 0 Maximum: 36 |
Parameter |
Type |
Description |
---|---|---|
gateway_id |
String |
Specifies the peer gateway ID. Minimum: 0 Maximum: 36 |
link_id |
String |
Specifies the connection ID of the peer gateway at the peer site. For example, if the peer gateway is an enterprise router, this parameter is set to the attachment ID. If the peer gateway is a global DC gateway, this parameter is set to the peer link ID. Minimum: 0 Maximum: 64 |
region_id |
String |
Specifies the region ID of the peer site. Minimum: 0 Maximum: 36 |
site_code |
String |
Specifies the site information of the global DC gateway. Minimum: 0 Maximum: 64 |
project_id |
String |
Specifies the project ID of the peer site. Minimum: 0 Maximum: 36 |
type |
String |
Specifies the type of the peer gateway.
Minimum: 0 Maximum: 64 |
Parameter |
Type |
Description |
---|---|---|
previous_marker |
String |
Specifies the marker of the previous page. The value is the resource UUID. Minimum: 0 Maximum: 36 |
current_count |
Integer |
Specifies the number of resources in the current list. Minimum: 0 Maximum: 2000 |
next_marker |
String |
Specifies the marker of the next page. The value is the resource UUID. If the value is empty, the resource is on the last page. Minimum: 0 Maximum: 36 |
Example Requests
GET https://{dc_endpoint}/v3/b197c48159d44a66b32c538c3f8da89a/dcaas/global-dc-gateways/1c6edc27-5fdb-4dae-ac77-72d47c70ed83/peer-links
Example Responses
Status code: 200
OK
- Peer link list that has been queried
{ "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 Sample Code
The SDK sample code is as follows.
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) } } |
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