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.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
URI
GET /v3/{project_id}/dcaas/global-dc-gateways/{global_dc_gateway_id}/peer-links
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition Specifies the project ID. Constraints N/A Range N/A Default Value N/A |
| global_dc_gateway_id | Yes | String | Definition Specifies the global DC gateway ID. Constraints N/A Range The value is in UUID format and is connected by hyphens (-). Default Value N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| limit | No | Integer | Definition Specifies the number of records returned on each page. Constraints N/A Range 1 to 2000 Default Value 2000 |
| offset | No | Integer | Definition Specifies the pagination offset. Constraints N/A Range 1–1000 Default Value N/A |
| marker | No | String | Definition Specifies the ID of the last resource record on the previous page. If this parameter is left blank, the first page is queried. Constraints This parameter must be used together with limit. Range The value can contain a maximum of 36 characters. Default Value N/A |
| page_reverse | No | Boolean | Definition Pagination parameter Constraints N/A Range Default Value N/A |
| fields | No | Array of strings | Definition Specifies the list of fields to be displayed. Constraints The array length ranges from 1 to 5. |
| ext_fields | No | Array of strings | Definition Specifies the extension fields. Constraints The array length ranges from 0 to 5. |
| sort_key | No | String | Definition Specifies the sorting key. Constraints N/A Range The value can contain a maximum of 36 characters. Default Value id |
| sort_dir | No | Array of strings | Definition Specifies the sorting order of returned results, which can be asc (ascending order) or desc (descending order). The default value is asc. Constraints N/A |
| id | No | Array of strings | Definition Specifies the resource ID by which instances are queried. Constraints The array length ranges from 1 to 5. |
| name | No | Array of strings | Definition Specifies the resource name by which instances are filtered. You can specify multiple names. Constraints The array length ranges from 1 to 5. |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | Definition Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. After the request is processed, the value of X-Subject-Token in the header is the token value. Constraints N/A Range N/A Default Value N/A |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| peer_links | Array of PeerLinkEntry objects | Definition Specifies the peer links. |
| page_info | PageInfo object | Definition Specifies the pagination query information. |
| request_id | String | Definition Specifies the request ID. Range The value can contain a maximum of 36 characters. |
| Parameter | Type | Description |
|---|---|---|
| id | String | Definition Specifies the peer link ID. Range The value can contain a maximum of 36 characters. |
| tenant_id | String | Definition Specifies the project ID. Range N/A |
| name | String | Definition Specifies the name of the peer link. Range The value can contain a maximum of 64 characters. |
| description | String | Definition Specifies the description. Range The value can contain a maximum of 255 characters. |
| reason | String | Definition Specifies the failure cause. Range The value can contain a maximum of 255 characters. |
| global_dc_gateway_id | String | Definition Specifies the ID of the global DC gateway that the peer link is added for. Range The value can contain a maximum of 64 characters. |
| bandwidth_info | BandWidthInfo object | Definition Specifies the bandwidth information. |
| peer_site | PeerSite object | Definition Provides supplementary information about the peer gateway. Range N/A |
| status | String | Definition Specifies the status of the peer link. Range |
| created_time | String | Definition Specifies the creation time. |
| updated_time | String | Definition Specifies the update time. |
| create_owner | String | Definition Specifies the cloud service where the peer link is used. |
| instance_id | String | Definition Specifies the instance ID Range N/A |
| Parameter | Type | Description |
|---|---|---|
| bandwidth_size | Integer | Definition Specifies the bandwidth. Range N/A |
| gcb_id | String | Definition Specifies the global connection bandwidth ID. Range The value can contain a maximum of 36 characters. |
| Parameter | Type | Description |
|---|---|---|
| gateway_id | String | Definition Specifies the peer gateway ID. Range The value can contain a maximum of 36 characters. |
| link_id | String | Definition 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. Range The value can contain a maximum of 64 characters. |
| region_id | String | Definition Specifies the region ID of the peer site. Range The value can contain a maximum of 36 characters. |
| site_code | String | Definition Specifies the site information of the global DC gateway. Range The value can contain a maximum of 64 characters. |
| project_id | String | Definition Specifies the project ID of the peer site. Range N/A |
| type | String | Definition Specifies the type of the peer gateway. Range |
| Parameter | Type | Description |
|---|---|---|
| previous_marker | String | Definition Specifies the marker of the previous page. The value is the resource UUID. Range The value can contain a maximum of 36 characters. |
| current_count | Integer | Definition Specifies the number of resources in the current list. Range 0 to 2000 |
| next_marker | String | Definition Specifies the marker of the next page. The value is the resource UUID. This parameter does not exist if the page is the last one. Range The value can contain a maximum of 36 characters. |
Example Requests
Querying the peer link list
GET https://{dc_endpoint}/v3/b197c48159d44a66b32c538c3f8da89a/dcaas/global-dc-gateways/1c6edc27-5fdb-4dae-ac77-72d47c70ed83/peer-links Example Responses
Status code: 200
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" : "xxxxxx",
"site_code" : "xxxxxx",
"project_id" : "6bea6e6ed6b34892bd2e195cad496348",
"type" : "ER"
},
"create_owner" : "cc",
"instance_id" : "f174fa3e-d63a-45bb-a5a4-b56782552494"
} ],
"page_info" : {
"previous_marker" : "5ad07c58-71a8-41b7-a5c0-5b6148d518b2",
"current_count" : 1
}
} 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 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.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.
What is your overall rating for this page?
Thank 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