CreateRouteMap - 创建路由策略

更新时间:
复制 MD 格式

用于创建一个新的路由策略,以控制网络实例间的路由行为。

接口说明

CreateRouteMap接口属于异步接口,即系统会先返回一个路由策略 ID,但该路由策略并未创建完成,系统后台的创建任务仍在进行。您可以调用ListRouteMaps接口查询路由策略的状态。

  • 当路由策略处于 Creating 状态时,表示路由策略正在创建中,在该状态下,您只能执行查询操作,不能执行其他操作。

  • 当路由策略处于 Active 状态时,表示路由策略创建完成。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cen:CreateRouteMap

create

*RouteMap

acs:cen:*:{#accountId}:routemap/*

无 无

请求语法

POST / HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

ClientToken

string

否

客户端 Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明

若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。

02fb3da4-130e-11e9-8e44-001****

Name

string

否

路由策略的名称。

名称可以为空或长度为 1~128 个字符,不能以 http://或 https://开头。

test

Description

string

否

路由策略的描述信息。

描述可以为空或长度为 1~256 个字符,不能以 http://或 https://开头。

descname

Priority

integer

是

路由策略的优先级。取值范围:1~100。优先级数字越小,表示优先级越高。

说明

一个用户账号下路由策略优先级唯一。执行路由策略时,系统从优先级数字最小的路由策略中按照路由策略规则的优先级开始匹配路由策略规则。因此在指定路由策略优先级时,要注意符合期望的匹配顺序。

3

Direction

string

是

路由策略的方向。取值:

  • Inbound:入方向。实例路由表从关联的网络实例接收路由的方向,影响当前实例能从关联的网络实例学习到哪些路由。

  • Outbound:出方向。实例路由表向关联的网络实例发送路由的方向,影响当前实例向关联的网络实例发布哪些路由。

枚举值:

  • Outbound :

    出方向

  • Inbound :

    入方向

Inbound

Tag

array<object>

否

标签信息。

一次最多支持输入 20 个标签信息。

object

否

Key

string

否

资源的标签键。

一旦传入该值,则不允许为空字符串。最多支持 64 个字符,不能以 aliyun 或者 acs:开头,不能包含 http://或者 https:// 。

一次最多支持输入 20 个标签的标签键。

tagtest

Value

string

否

资源的标签值。

一旦传入该值,则不允许为空。支持输入不超过 128 个字符的字符串,不能以 aliyun 或者 acs:开头,不能包含 http://或者 https:// 。

每一个标签键对应一个标签值,一次最多支持输入 20 个标签键对应的标签值。

tagtest

ResourceGroupId

string

否

资源组 ID。

rg-acfm3unpnuw****

DryRun

boolean

否

是否对此次请求执行预检,包括权限、实例状态校验等。取值:

  • false(默认):发送正常请求,通过检查后直接创建路由策略。

  • true:发送检查请求,只进行校验,不会创建路由策略。检查项包括是否填写了必需参数、请求格式等。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation。

false

返回参数

名称

类型

描述

示例值

object

创建成功

RouteMapId

string

路由策略的 ID。

rm-abcdedfghij****

RequestId

string

请求 ID。

0C2EE7A8-74D4-4081-8236-CEBDE3BBCF50

示例

正常返回示例

JSON格式

{
  "RouteMapId": "rm-abcdedfghij****",
  "RequestId": "0C2EE7A8-74D4-4081-8236-CEBDE3BBCF50"
}

错误码

HTTP status code

错误码

错误信息

描述

400 QuotaExceeded.RouteMap The maximum number of RouteMap is exceeded. 路由策略数量超限。
400 OperationUnsupported.RouteMap Operate RouteMap is not supported. 不支持配置路由策略。
400 InvalidOperation.RouteMapPriorityConflict Operation is invalid because the route map priority conflicts with existing maps. 路由策略优先级与其他策略冲突。
400 InvalidName The name is invalid name不合法。
400 InvalidDescription The description is invalid 描述不合法。
400 InvalidParameter.Priority The specified priority is invalid. 输入的优先级参数不合法。
400 InvalidParameter.Direction The specified direction is invalid. 输入的方向不合法。
400 InvalidParameter.TagValue The specified parameter TagValue is invalid. 输入的参数Tag Value不合法。

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。