调用CreateTransitRouter接口创建企业版转发路由器实例。

使用说明

  • 您可以通过调用CreateTransitRouter接口创建企业版转发路由器实例。当前企业版转发路由器只在部分地域开放，关于地域的详细信息，请参见什么是云企业网。
  • CreateTransitRouter接口属于异步接口，即系统会先返回一个企业版转发路由器实例ID，但该企业版转发路由器实例并未创建完成，系统后台的创建任务仍在进行。您可以调用ListTransitRouters接口查询企业版转发路由器实例的状态。
    • 当企业版转发路由器实例处于Creating状态时，表示企业版转发路由器实例正在创建中，在该状态下，您只能对企业版转发路由器实例执行查询操作，不能执行其他操作。
    • 当企业版转发路由器实例处于Active状态时，表示企业版转发路由器实例创建完成。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 CreateTransitRouter

系统规定参数。取值：CreateTransitRouter。

ClientToken String 否 02fb3da4-130e-11e9-8e44-001****

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

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

说明 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
CenId String 是 cen-j3jzhw1zpau2km****

云企业网实例ID。
RegionId String 是 cn-zhangjiakou

企业版转发路由器实例所属地域ID。

您可以通过调用DescribeChildInstanceRegions接口获取地域ID。

TransitRouterName String 否 testname

企业版转发路由器实例的名称。

名称长度为2~128个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-），但不能以http://或https://开头。

TransitRouterDescription String 否 testdesc

企业版转发路由器实例的描述。

描述长度为2~256个字符，必须以字母或中文开头，但不能以http://或https://开头。

DryRun Boolean 否 false

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

  • false（默认值）：发送正常请求，通过检查后直接创建企业版转发路由器实例。
  • true：发送检查请求，只进行校验，不会创建企业版转发路由器实例。检查项包括是否填写了必需参数、请求格式等。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。
SupportMulticast Boolean 否 false

是否开启企业版转发路由器的组播功能。取值：

  • false（默认值）：不开启。
  • true：开启。

仅部分地域的企业版转发路由器支持组播功能，您可以调用ListTransitRouterAvailableResource接口查询支持组播功能的地域信息。

TransitRouterCidrList Array 否

转发路由器地址段列表。

一次最多支持添加5个转发路由器地址段。关于转发路由器地址段的更多信息，请参见转发路由器地址段。

说明 仅企业版转发路由器支持添加地址段。
Cidr String 否 192.168.10.0/24

转发路由器地址段。
Name String 否 nametest

转发路由器地址段的名称。

名称长度为1~128个字符。
Description String 否 desctest

转发路由器地址段的描述信息。

描述长度为1~256个字符。
PublishCidrRoute Boolean 否 true

是否允许系统自动在转发路由器路由表中添加转发路由器地址段的路由。

  • true（默认值）：允许。

    如果您选择了允许，则在您创建了私网网关类型的VPN连接，并为私网网关类型的VPN连接创建了路由学习关系后，系统自动在与VPN连接建立路由学习关系的转发路由器路由表中添加一条路由条目：

    目标网段为转发路由器地址段的黑洞路由，其中转发路由器地址段指已为IPsec连接分配网关IP地址的地址段。

    该黑洞路由仅会被传播至转发路由器下边界路由器VBR（Virtual Border Router）实例的路由表中。

  • false：不允许。
Tag.N.Key String 否 tagtest

资源的标签键。

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

一次最多支持输入20个标签的标签键。
Tag.N.Value String 否 TagValue

资源的标签值。

标签值可以为空或输入不超过128个字符的字符串，不能以aliyun或者acs:开头，不能包含http://或者https:// 。

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

返回数据

名称 类型 示例值 描述
TransitRouterId String tr-uf6llz2286805i44g****

企业版转发路由器实例ID。
RequestId String 404DA7EC-F495-44B5-B543-6EDCDF90F3D1

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateTransitRouter
&ClientToken=02fb3da4-130e-11e9-8e44-001****
&CenId=cen-j3jzhw1zpau2km****
&RegionId=cn-zhangjiakou
&TransitRouterName=testname
&TransitRouterDescription=testdesc
&DryRun=false
&SupportMulticast=false
&TransitRouterCidrList=[{"Cidr":"192.168.10.0/24","Name":"nametest","Description":"desctest","PublishCidrRoute":true}]
&Tag=[{"Key":"tagtest","Value":"TagValue"}]
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateTransitRouterResponse>
    <TransitRouterId>tr-uf6llz2286805i44g****</TransitRouterId>
    <RequestId>404DA7EC-F495-44B5-B543-6EDCDF90F3D1</RequestId>
</CreateTransitRouterResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TransitRouterId" : "tr-uf6llz2286805i44g****",
  "RequestId" : "404DA7EC-F495-44B5-B543-6EDCDF90F3D1"
}

错误码

HttpCode 错误码 错误信息 描述
400 InstanceExist.TransitRouterInstance The instance already exists. 当前Region下的TransitRouter实例已经存在，不允许同一个Region下重复创建。
400 Forbbiden.TransitRouterServiceNotOpen The user has not open transit router service. 转发路由器服务未开通，请开通后再使用。
400 IllegalParam.Region The specified region is invalid. 指定的region非法

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