批量增加路由条目--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

批量增加路由条目

最近更新时间：2024.07.18 11:03:31首次发布时间：2023.02.08 11:43:01

本接口用于批量增加自定义路由条目。

使用说明

使用限制：
单个路由表中，最多可以添加20条自定义路由条目。

请求说明

请求方式：POST
请求地址：https://veenedge.volcengineapi.com/?Action=CreateRouteEntries&Version=2021-04-30

请求参数

下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。其他公共参数，请参见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`CreateRouteEntries`	接口名称。当前 API 的名称为 `CreateRouteEntries`。
Version	String	是	`2021-04-30`	接口版本。当前 API 的版本为 `2021-04-30`。

Body

参数	类型	是否必选	示例值	描述
route_table_identity	String	是	`route-table-7fs74n****`	路由表 ID。您可以通过 ListRouteTables 接口获取路由表 ID。
route_entry_list	[]RouteEntryList	是	`见下文说明`	要增加的路由条目的列表。

RouteEntryList

参数	类型	是否必选	示例值	描述
type	String	是	`custom`	路由条目的类型。取值范围： custom：自定义路由条目。
dest_cidr	String	是	`114...0/16`	目的地址。目的地址使用 CIDR 格式。不支持 IPv6 地址。
next_hop_type	String	是	`veen`	下一跳类型。取值范围： veen：边缘实例。 vpc_vgw：边缘云网关。 havip：高可用虚拟 IP。 natgw：NAT 网关。说明当前，如需使用边缘云网关服务，请联系客户经理进行申请。
next_hop	String	是	`172...3`	下一跳：当 next_hop_type 为 veen 时，next_hop 须指定为边缘实例的主私网 IP 地址。当 next_hop_type 为 vpc_vgw 时，next_hop 须指定为边缘云网关的 ID 。当 next_hop_type 为 havip 时，next_hop 须指定为高可用虚拟 IP 的 ID。当 next_hop_type 为 natgw 时，next_hop 须指定为 NAT 网关的 ID。
desc	String	是	`test_desc`	路由条目的描述。最多可输入 80 个字符。
is_enable	Boolean	是	`true`	是否启用路由条目。取值范围： true：启用路由条目。 false：不启用路由条目。

返回参数

参数	类型	示例值	描述
route_entry_id_list	[]String	`["route-entry-nzpp5c****"]`	路由条目 ID 列表。

请求示例

POST https://veenedge.volcengineapi.com/?Action=CreateRouteEntries&Version=2021-04-30
&<其他公共参数>
{
    "route_table_identity": "route-table-7fs74n****",
    "route_entry_list": [
          {
            "desc": "test_desc",
            "dest_cidr": "1.**.**.0/16",
            "is_enable": true,
            "next_hop": "172.**.**.3",
            "next_hop_type": "veen",
            "type": "custom"
          }
    ]
}

返回示例

{
    "ResponseMetadata":{
        "RequestId":"20230523174236C493BF5AF445A6DC****",
        "Action":"CreateRouteEntries",
        "Version":"2021-04-30",
        "Service":"veenedge",
        "Region":"cn-north-1"
    },
    "Result":{
        "route_entry_id_list": [
          "route-entry-nzpp5c****"
        ]
    }
}

错误码

如果响应正文中包含 Error 字段，则表示 API 请求失败。关于错误码的更多信息，参见错误码。