Querying the Connect Gateway List
Function
This API is used to query the list of connect gateways.
Calling Method
For details, see Calling APIs.
URI
GET /v3/{project_id}/dcaas/connect-gateways
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Specifies the project ID. Minimum: 0 Maximum: 36 |
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 |
status |
No |
Array of strings |
Specifies the status by which instances are filtered. 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 |
---|---|---|
request_id |
String |
Specifies the request ID. |
connect_gateways |
Array of ConnectGatewayResponse objects |
Specifies the connect gateway. |
total_count |
Integer |
Total number of resources |
page_info |
PageInfo object |
Specifies the pagination query information. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Specifies the unique ID of the connect gateway. |
tenant_id |
String |
Specifies the tenant ID. |
name |
String |
Specifies the gateway name. |
description |
String |
Provides supplementary information about the connect gateway. |
address_family |
String |
Specifies the address family.
|
status |
String |
Specifies the connect gateway status.
|
access_site |
String |
Specifies the access site of the connect gateway. |
bgp_asn |
Long |
Specifies the BGP ASN. |
current_geip_count |
Integer |
Specifies the number of global EIPs bound to the connect gateway. |
created_time |
String |
Specifies the time when the connect gateway was created. |
updated_time |
String |
Specifies the time when the connect gateway was updated. |
gcb_id |
String |
Specifies the global connection bandwidth ID. |
gateway_site |
String |
Specifies the gateway location. |
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
Querying List of Connect Gateway.
GET https://{dc_endpoint}/v3/b197c48159d44a66b32c538c3f8da89a/dcaas/connect-gateways
Example Responses
Status code: 200
OK
- Connect gateway list that has been queried
{ "request_id" : "620dd1f696304f95a5d4fa4b9a21505e", "connect_gateways" : [ { "name" : "cgw-test", "id" : "934aa302-5f1a-44c8-855b-20f715e2dbf3", "description" : "", "created_time" : "2024-12-12T06:12:15Z", "updated_time" : null, "tenant_id" : "b197c48159d44a66b32c538c3f8da89a", "status" : "DOWN", "bgp_asn" : 139144, "address_family" : "dual", "access_site" : null, "current_geip_count" : 0, "gcb_id" : null, "gateway_site" : null } ], "total_count": 1, "page_info" : { "previous_marker" : "0ffe48a8-053a-483d-aa04-70f675eda4e6", "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 |
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 ListConnectGatewaysSolution { 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(); ListConnectGatewaysRequest request = new ListConnectGatewaysRequest(); try { ListConnectGatewaysResponse response = client.listConnectGateways(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 |
# 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 = ListConnectGatewaysRequest() response = client.list_connect_gateways(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 |
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.ListConnectGatewaysRequest{} response, err := client.ListConnectGateways(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