# 查询全域接入网关路由表 - ListGdgwRouteTables #### 功能介绍 查询全域接入网关路由表 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dc/zh-cn_topic_0055025302.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dc/dc_08_3000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dcaas:gdgw:listGdgwRouteTable | List | gdgw \* | - g:EnterpriseProjectId - g:ResourceTag/\ | - | - | #### URI GET /v3/{project_id}/dcaas/gdgw/{gdgw_id}/routetables 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 租户项目ID 最小长度：**0** 最大长度：**36** | | gdgw_id | 是 | String | 全域接入网关ID | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | fields | 否 | Array of strings | 显示字段列表 数组长度：**1 - 5** | | ext_fields | 否 | Array of strings | show response ext-fields 数组长度：**0 - 5** | | limit | 否 | Integer | 每页返回的个数。 取值范围：1\~2000。 最小值：**1** 最大值：**2000** 缺省值：**2000** | | marker | 否 | String | 上一页最后一条资源记录的ID，为空时为查询第一页。 使用说明：必须与limit一起使用。 最小长度：**0** 最大长度：**36** | | nexthop | 否 | Array of strings | 下一条ID | | destination | 否 | Array of strings | 目的地址 | | address_family | 否 | Array of strings | 地址簇 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。 获取Token，请参考《统一身份认证服务API参考》的"获取用户Token"章节。请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 最小长度：**0** 最大长度：**10240** | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | request_id | String | 请求id | | gdgw_routetables | Array of [CommonRoutetable] objects | 全域接入网关路由表 | | total_count | Integer | 总记录数 | | page_info | [PageInfo] object | 分页查询页的信息 | 表5CommonRoutetable | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 路由id | | tenant_id | String | 租户id | | gateway_id | String | 网关id | | destination | String | 路由子网 | | nexthop | String | 下一跳id | | obtain_mode | String | 路由类型: - customized: 默认路由 - specific: 自定义路由 - bgp: 动态路由 | | status | String | 路由状态: - ACTIVE: 下发正常 - ERROR: 下发失败 - PENDING_CREATE: 待下发 | | address_family | String | 地址族类型: - ipv4: ipv4 - ipv6: ipv6 | | description | String | 路由描述 | | type | String | 下一跳类型: - vif_peer: 虚拟接口对等体 - gdgw: 全域接入网关 | 表6PageInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | previous_marker | String | 上一页的marker，值为资源的uuid | | current_count | Integer | 当前列表中资源数量 | | next_marker | String | 下一页的marker，值为资源的uuid，最后一页时无next_marker字段 | #### 请求示例 查询全域接入网关路由表 ``` GET https://{dc_endpoint}/v3/4bd6efdb0fb747b39aa2c0162c112226/dcaas/gdgw/0851a5e0-6623-42c2-bb02-b8956e313dd8/routetables ``` #### 响应示例 **状态码：200** OK 查询全域接入网关路由表响应体 ``` { "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] ``` 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("")) .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] ``` # 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("")) \ .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] ``` 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("")). 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](https://console.huaweicloud.com/apiexplorer/#/openapi/DC/sdk?api=ListGdgwRouteTables)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dc/ErrorCode.html)。