Querying Global DC Gateway Route Tables
Function
This API is used to query the route tables for a global DC gateway.
Calling Method
For details, see Calling APIs.
URI
GET /v3/{project_id}/dcaas/gdgw/{gdgw_id}/routetables
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Specifies the project ID. Minimum: 0 Maximum: 36 |
gdgw_id |
Yes |
String |
Specifies the global DC gateway ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
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 |
nexthop |
No |
Array of strings |
Specifies the next hop ID. |
destination |
No |
Array of strings |
Specifies the destination. |
address_family |
No |
Array of strings |
Specifies the address family. |
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. Minimum: 0 Maximum: 36 |
gdgw_routetable |
Array of CommonRoutetable objects |
Specifies the route table for the global DC gateway. Array Length: 0 - 2000 |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Specifies the route ID. Minimum: 36 Maximum: 36 |
tenant_id |
String |
Specifies the tenant ID. Minimum: 64 Maximum: 64 |
gateway_id |
String |
Specifies the gateway ID. Minimum: 36 Maximum: 36 |
destination |
String |
Specifies the subnet the route is destined for. Minimum: 64 Maximum: 64 |
nexthop |
String |
Specifies the next hop ID. Minimum: 36 Maximum: 36 |
obtain_mode |
String |
Specifies the route type.
|
status |
String |
Specifies the route status.
|
address_family |
String |
Specifies the address family.
|
description |
String |
Describes the route. Minimum: 0 Maximum: 1024 |
type |
String |
Next hop type
Minimum: 0 Maximum: 255 |
Example Requests
Querying Global Dc Gateway Route Tables
GET https://{dc_endpoint}/v3/4bd6efdb0fb747b39aa2c0162c112226/dcaas/gdgw/0851a5e0-6623-42c2-bb02-b8956e313dd8/routetables
Example Responses
Status code: 200
OK
- Querying Global Dc Gateway Route Tables Response Body.
{ "request_id" : "409ed40b-7ccf-4514-8ca8-af2b994e4023", "gdgw_routetable" : [ { "id" : "14d55a22-9d08-46af-bc2e-f965f9558234", "description" : "subnet route", "tenant_id" : "00000000000000000000000000000000", "gateway_id" : "5791e3c8-b43d-4751-bfeb-a643e40e6086", "destination" : "x.x.0.0/16", "nexthop" : "409ed40b-7ccf-4514-8ca8-af2b994e4023", "type" : "vif_peer", "obtain_mode" : "customized", "status" : "ACTIVE", "address_family" : "ipv4" } ] }
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 ListGdgwRouteTablesSolution { 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(); ListGdgwRouteTablesRequest request = new ListGdgwRouteTablesRequest(); request.withGdgwId("{gdgw_id}"); try { ListGdgwRouteTablesResponse response = client.listGdgwRouteTables(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 = ListGdgwRouteTablesRequest() request.gdgw_id = "{gdgw_id}" response = client.list_gdgw_route_tables(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.ListGdgwRouteTablesRequest{} request.GdgwId = "{gdgw_id}" response, err := client.ListGdgwRouteTables(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