CreateRoute

1. 接口描述

本接口用于创建一个自定义路由。

注意事项

  • 指定的下一跳网卡状态必须处于这几种状态之一:AVAILABLEATTACHINGDETACHINGUSED

  • 指定的下一跳网卡必须在指定的VPC下。

  • 路由类型支持创建静态和策略两种。

  • 同一个VPC不能存在多个相同的配置,即(策略路由:源IP目的CIDR不能都一样, 静态路由:目的CIDR不能相同)

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称
必选
类型
描述

vpcId

String

VPC的ID。

ipVersion

IP类型。

支持IPv4IPv6两种类型。

routeType

路由类型。

sourceIp

String

源IP地址。

路由类型配置RouteTypePolicy(策略路由)时需指定。

destinationCidrBlock

String

IPv4或IPv6的目标网段。

例如:10.0.1.0/24。

priority

Integer

路由优先级。

数值越小,优先级越高。

可选值范围:[0, 65535]。

nextHopId

String

下一跳资源ID。

目前只支持网卡ID。

name

String

路由名称。

名称长度为 2 到 63 个字符,仅支持字母、数字、连字符 (-) 、下划线(_) 、斜杠(/) 、和句点 (.),且开头和结尾必须是字母或数字。

3. 响应结果

参数名称
类型
描述

requestId

String

唯一请求 ID。

每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

routeId

String

创建的路由ID。

4. 代码示例

1. 创建一条IPv4的静态路由。

POST /api/v2/zec HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: CreateRoute
<Common Request Params>

Request:
{
  "vpcId": "<vpcId>",
  "ipVersion": "IPv4",
  "routeType": "RouteTypeStatic",
  "destinationCidrBlock": "10.0.0.0/8",
  "priority": 2,
  "nextHopId": "<nicId>",
  "name": "Test",
}

Response:
{
  "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
  "response": {
    "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
    "routeId": "<routeId>"
  }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集(SDK),未来会陆续支持更多开发语言,方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码,其他错误码见公共错误码

HTTP状态码
错误码
说明

404

INVALID_NIC_NOT_FOUND

网卡不存在。

400

INVALID_NIC_STATUS

当前网卡状态无法进行操作。

409

INVALID_NIC_ZBG_REGION_MISMATCH

网卡的区域与边界网关区域不匹配。

404

INVALID_REGION_NOT_FOUND

指定的可用区不存在。

404

INVALID_VPC_NOT_FOUND

VPC不存在。

404

INVALID_ZBG_NOT_FOUND

边界网关不存在。

400

OPERATION_DENIED_SUBNET_CIDR_CONFLICT

CIDR和子网CIDR有冲突。

400

OPERATION_DENIED_VPC_NOT_EXIST_NIC

VPC不存在指定的网卡。

Last updated