1. 接口描述
接口请求域名: bmvpc.tencentcloudapi.com 。
本接口(DescribeRoutePolicies)用于查询路由表条目。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeRoutePolicies。 |
Version | 是 | String | 公共参数,本接口取值:2018-06-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
RouteTableId | 是 | String | 路由表实例ID,例如:rtb-afg8md3c。 示例值:rtb-afg8md3c |
RoutePolicyIds.N | 否 | Array of String | 路由策略实例ID,例如:rti-azd4dt1c。 示例值:["rti-q1j48dkd\r\n"] |
Filters.N | 否 | Array of Filter | 过滤条件,参数不支持同时指定RoutePolicyIds和Filters。 route-table-id - String - (过滤条件)路由表实例ID。 vpc-id - String - (过滤条件)VPC实例ID,形如:vpc-f49l6u0z。 route-policy-id - String - (过滤条件)路由策略ID。 route-policy-description-like - String -(过滤条件)路由项备注。 route-policy-type - String - (过滤条件)路由项策略类型。 destination-cidr-like - String - (过滤条件)路由项目的地址。 gateway-id-like - String - (过滤条件)路由项下一跳网关。 gateway-type - String - (过滤条件)路由项下一条网关类型。 enable - Bool - (过滤条件)路由策略是否启用。 |
Offset | 否 | Integer | 初始行的偏移量,默认为0。 示例值:0 |
Limit | 否 | Integer | 每页行数,默认为20。 示例值:20 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 路由策略数 示例值:2 |
RoutePolicySet | Array of RoutePolicy | 路由策略列表 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询黑石路由表条目
输入示例
https://bmvpc.tencentcloudapi.com/?Action=DescribeRoutePolicies
&RouteTableId=rtb-afg8md3c
&RoutePolicyIds.0=rti-q1j48dkd
&<公共请求参数>
输出示例
{
"Response": {
"RoutePolicySet": [
{
"RoutePolicyId": "Local",
"RouteDescription": "",
"DestinationCidrBlock": "Local",
"GatewayType": "LOCAL",
"GatewayId": "Local",
"RoutePolicyType": "NETD",
"Enabled": true
},
{
"RoutePolicyId": "rti-q9eyoybe",
"RouteDescription": "",
"DestinationCidrBlock": "169.254.0.0/23",
"GatewayType": "SSHSSLVPN",
"GatewayId": "sslvpngw-o7tpr54i",
"RoutePolicyType": "NETD",
"Enabled": true
}
],
"TotalCount": 2,
"RequestId": "62735da7-4546-4d63-8d42-36ced3bd3d94"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
UnauthorizedOperation | 未授权操作。 |