1. 接口描述
本接口(CreateRoute)用于新增路由策略。
接口请求域名:vpc.api.qcloud.com
您可以针对某个路由表批量新增路由策略。
2. 输入参数
以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,详情请参见 公共请求参数 页面。其中,此接口的Action字段为CreateRoute。
参数名称 | 是否必选 | 类型 | 描述 |
---|---|---|---|
vpcId | 是 | String | 路由表所属的私有网络 ID 值,可使用 vpcId 或 unVpcId,建议使用 unVpcId,例如:vpc-rqndayhs。可通过DescribeVpcEx接口查询。 |
routeTableId | 是 | String | 系统分配的路由表ID值,可使用routeTableId或unRouteTableId,建议使用unRouteTableId,例如:rtb-rqndayhs。可通过 DescribeRouteTable 接口查询。 |
routeSet.n | 是 | array | 路由表内容。 |
routeSet.n.destinationCidrBlock | 是 | String | 目的网段,取值不能在私有网络网段内,例如:112.20.51.0/24。 |
routeSet.n.nextType | 是 | String | 下一跳类型,目前我们支持的类型有:0:公网网关类型的云服务器;1:VPN 网关; 3:专线网关;4:对等连接;7:SSL VPN 网关;8:NAT 网关; 9:普通云服务器。 |
routeSet.n.nextHub | 是 | String | 下一跳地址,这里只需要指定不同下一跳类型的网关 ID(推荐使用新 ID),系统会自动匹配到下一跳地址。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 错误码,0: 成功,其他值: 失败。 |
message | String | 错误信息。 |
4. 错误码表
以下错误码表仅列出了该接口的业务逻辑错误码,更多公共错误码详见 VPC 错误码。
错误码 | 描述 |
---|---|
InvalidVpc.NotFound | 无效的 VPC。VPC 资源不存在,请再次核实您输入的资源信息是否正确,可通过 DescribeVpcEx 接口查询 VPC。 |
InvalidRouteTableId.NotFound | 无效的路由表。路由表 ID 不存在,请再次核实您输入的资源信息是否正确,可通过 DescribeRouteTable 接口查询。 |
InvalidDestinationCidr | 目标网段不合法。 |
RouteLimitExceeded | 路由表策略数超过上限。如果需要更多资源,请联系客服申请。更多 VPC 资源限制信息详见 VPC 使用限制。 |
RouteAlreadyExists | 目标网段在路由表策略中已存在。同一个路由表里策略中,目标网段不能冲突。 |
InvalidRouteNextType | 无效的下一跳类型。可以支持的类型详见入参说明。 |
InvalidRouteNextHub.NotFound | 下一跳地址不存在。请核实您填写的下一跳地址资源 ID 是否正确。 |
5. 示例
输入
https://vpc.api.qcloud.com/v2/index.php?Action=CreateRoute &<公共请求参数> &vpcId=vpc-amhnnao5 &routeTableId=rtb-4ahe1qy2 &routeSet.0.destinationCidrBlock=121.0.23.51/16 &routeSet.0.nextType=1 &routeSet.0.nextHub=vpngw-dystbrkv
输出
{
"code": 0,
"message": ""
}