查询全域接入网关路由表 - ListGdgwRouteTables
功能介绍
查询全域接入网关路由表
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
URI
GET /v3/{project_id}/dcaas/gdgw/{gdgw_id}/routetables
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 租户项目ID。获取方法请参见《统一身份认证服务API参考》的『获取账号项目ID』章节,或通过查询项目列表接口获取 约束限制: 不涉及 取值范围: 32 位十六进制字符(0-9, a-f, A-F) 默认取值: 不涉及 |
| gdgw_id | 是 | String | 参数解释: 全域接入网关ID 约束限制: 不涉及 取值范围: UUID 格式,以连字符(-)连接 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| fields | 否 | Array of strings | 参数解释: 显示字段列表,数组中每个字符串为虚拟接口对象的字段名(如 id、name、admin_state_up、bandwidth、status 等) 约束限制: 数组长度为1~5 取值范围: 不涉及 默认取值: 不涉及 |
| ext_fields | 否 | Array of strings | 参数解释: show response ext-fields 约束限制: 数组长度为0~5 |
| limit | 否 | Integer | 参数解释: 每页返回的个数。 约束限制: 不涉及 取值范围: 1~2000。 默认取值: 2000 |
| marker | 否 | String | 参数解释: 上一页最后一条资源记录的ID,为空时为查询第一页。 约束限制: 必须与limit一起使用。 取值范围: 长度不超过36个字符 默认取值: 不涉及 |
| nexthop | 否 | Array of strings | 参数解释: 下一跳ID 约束限制: 不涉及 |
| destination | 否 | Array of strings | 参数解释: 目的地址 约束限制: 不涉及 |
| address_family | 否 | Array of strings | 参数解释: 地址簇 约束限制: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 获取Token,请参考《统一身份认证服务API参考》的「获取用户Token」章节。请求响应成功后在响应消息头中包含的「X-Subject-Token」的值即为Token值。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| request_id | String | 参数解释: 请求id 取值范围: 长度不超过36个字符 |
| gdgw_routetables | Array of CommonRoutetable objects | 参数解释: 全域接入网关路由表 |
| total_count | Integer | 参数解释: 总记录数 取值范围: 不涉及 |
| page_info | PageInfo object | 参数解释: 分页查询页的信息 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 路由id 取值范围: 长度为36个字符 |
| tenant_id | String | 参数解释: 租户id 取值范围: 不涉及 |
| gateway_id | String | 参数解释: 网关id 取值范围: 长度为36个字符 |
| destination | String | 参数解释: 路由子网 取值范围: 不涉及 |
| nexthop | String | 参数解释: 下一跳id 取值范围: 长度为36个字符 |
| obtain_mode | String | 参数解释: 路由类型: 取值范围: |
| status | String | 参数解释: 路由状态: 取值范围: |
| address_family | String | 参数解释: 地址族类型: 取值范围: |
| description | String | 参数解释: 路由描述 取值范围: 长度不超过1024个字符 |
| type | String | 参数解释: 下一跳类型: 取值范围: |
请求示例
查询全域接入网关路由表
GET https://{dc_endpoint}/v3/4bd6efdb0fb747b39aa2c0162c112226/dcaas/gdgw/0851a5e0-6623-42c2-bb02-b8956e313dd8/routetables 响应示例
状态码:200
查询全域接入网关路由表响应体
{
"request_id" : "409ed40b-7ccf-4514-8ca8-af2b994e4023",
"gdgw_routetables" : [ {
"id" : "14d55a22-9d08-46af-bc2e-f965f9558234",
"description" : "v4子网路由",
"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"
} ],
"total_count" : 1,
"page_info" : {
"previous_marker" : "54bf7a78-1a7d-4d42-ac07-abb2f903f2c1",
"current_count" : 1
}
} SDK代码示例
SDK代码示例如下。
Java
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()); } } } |
Python
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) |
Go
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.ListGdgwRouteTablesRequest{} request.GdgwId = "{gdgw_id}" response, err := client.ListGdgwRouteTables(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
错误码
请参见错误码。