CreateTransitRouter - 创建企业版转发路由器实例 - 云企业网

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

接口说明

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
cen:CreateTransitRouter	create	CenInstance acs:cen::{#accountId}:ceninstance/{#ceninstanceId} TransitRouter acs:cen::{#accountId}:centransitrouter/*	无	无

请求参数

名称	类型	必填	描述	示例值
ClientToken	string	否	客户端 Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。说明若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。	02fb3da4-130e-11e9-8e44-001****
CenId	string	是	云企业网实例 ID。	cen-j3jzhw1zpau2km****
RegionId	string	是	企业版转发路由器实例所属地域 ID。您可以通过调用 DescribeChildInstanceRegions 接口获取地域 ID。	cn-zhangjiakou
TransitRouterName	string	否	企业版转发路由器实例的名称。名称可以为空或长度为 1～128 个字符，不能以 http://或 https://开头。	testname
TransitRouterDescription	string	否	企业版转发路由器实例的描述。描述可以为空或长度为 1～256 个字符，不能以 http://或 https://开头。	testdesc
DryRun	boolean	否	是否对此次创建请求执行预检，包括权限、实例状态校验等。取值： false（默认值）：发送正常请求，通过检查后直接创建企业版转发路由器实例。 true：发送检查请求，只进行校验，不会创建企业版转发路由器实例。检查项包括是否填写了必需参数、请求格式等。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。	false
SupportMulticast	boolean	否	是否开启企业版转发路由器的组播功能。取值： false（默认值）：不开启。 true：开启。仅部分地域的企业版转发路由器支持组播功能，您可以调用 ListTransitRouterAvailableResource 接口查询支持组播功能的地域信息。	false
TransitRouterCidrList	array<object>	否	转发路由器地址段列表。
	object	否	转发路由器地址段列表。一次最多支持添加 5 个转发路由器地址段。关于转发路由器地址段的更多信息，请参见转发路由器地址段。说明仅企业版转发路由器支持添加地址段。
Cidr	string	否	转发路由器地址段。	192.168.10.0/24
Name	string	否	转发路由器地址段的名称。名称长度为 1~128 个字符。	nametest
Description	string	否	转发路由器地址段的描述信息。描述长度为 1~256 个字符。	desctest
PublishCidrRoute	boolean	否	是否允许系统自动在转发路由器路由表中添加转发路由器地址段的路由。 true（默认值）：允许。如果您选择了允许，则在您创建了私网网关类型的 VPN 连接，并为私网网关类型的 VPN 连接创建了路由学习关系后，系统自动在与 VPN 连接建立路由学习关系的转发路由器路由表中添加一条路由条目：目标网段为转发路由器地址段的黑洞路由，其中转发路由器地址段指已为 IPsec 连接分配网关 IP 地址的地址段。该黑洞路由仅会被传播至转发路由器下边界路由器 VBR（Virtual Border Router）实例的路由表中。 false：不允许。	true
Tag	array<object>	否	标签信息。
	object	否	标签信息。一次最多支持输入 20 个标签信息。
Key	string	否	资源的标签键。一旦传入该值，则不允许为空字符串。最多支持 64 个字符，不能以`aliyun`或者`acs:`开头，不能包含`http://`或者`https://` 。一次最多支持输入 20 个标签的标签键。	tagtest
Value	string	否	资源的标签值。标签值可以为空或输入不超过 128 个字符的字符串，不能以`aliyun`或者`acs:`开头，不能包含`http://`或者`https://` 。每一个标签键对应一个标签值，一次最多支持输入 20 个标签键对应的标签值。	TagValue

返回参数

名称	类型	描述	示例值
	object	返回结果。
TransitRouterId	string	企业版转发路由器实例 ID。	tr-uf6llz2286805i44g****
RequestId	string	请求 ID。	404DA7EC-F495-44B5-B543-6EDCDF90F3D1

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	OperationUnsupported.RegionId	The specified Region is not supported.	当前地域不支持该操作。
400	InstanceExist.TransitRouterInstance	The instance already exists.	当前Region下的TransitRouter实例已经存在，不允许同一个Region下重复创建。
400	Forbbiden.TransitRouterServiceNotOpen	The user has not open transit router service.	转发路由器服务未打开，请打开后重试。
400	OperationUnsupported.SupportMulticast	The multicast is not supported in the specified region.	当前地域不支持组播。
400	OperationUnsupported.CenFullLevel	CEN full level does not support TransitRouter.	-
400	IllegalParam.Cidr	Cidr is illegal.	参数中指定的cidr不合法。
400	Illegal.TrType	The TransitRouter type is illegal.	转发路由器类型不支持该操作。
400	OperationUnsupported.TransitRouterCidrList	The TransitRouterCidrList is not support in the specified Region.	当前地域不支持该操作。
400	OperationFailed.CidrConflict	Operation is invalid because the cidr conflict.	cidr冲突。
400	IllegalParam.Region	The specified region is invalid.	参数中指定的Region不合法。
400	OverLappingExist.Cidr	The cidr overlapping exist.	cidr overlapping已存在。
400	IllegalParam.ServiceMode	The specified ServiceMode is invalid.	参数中指定的ServiceMode不合法。
400	ParamExclusive.ServiceModeAndSupportMulticast	ServiceMode and SupportMulticast is mutually exclusive.	该模式的转发路由器不支持开启组播功能。
400	ParamExclusive.ServiceModeAndTransitRouterCidrList	ServiceMode and TransitRouterCidrList is mutually exclusive.	该模式的转发路由器不支持开启cidr功能。
400	OperationUnsupported.Tag	The Tag is not supported in the specified region.	该地域不支持转发路由器Tag功能。
400	IllegalParam.SupportMulticast	Basic Transit router is not support multicast.	基础版转发路由器不支持组播功能。
400	ParamExclusive.BasicAndPrimaryStandby	Basic and PrimaryStandby is mutually exclusive.	基础版转发路由器不支持设置模式为PrimaryStandby。
400	ParamExclusive.BasicAndMultiPrimary	Basic and MultiPrimary is mutually exclusive.	基础版转发路由器不支持设置模式为MultiPrimary。
400	IllegalParam.RegionId	The Specified Parameter RegionId is illegal.	参数中指定的Region不合法。
400	OperationFailed.PostPay95BwpNotAllowEnterpriseTr	Cbn with post pay 95 bandwidth package does not allow enterprise tr.	使用老95带宽包的云企业网不允许创建企业版转发路由器。
400	Forbidden.TransitRouterServiceExpired	The transit router service is out of service.	转发路由器服务已欠费停服，请续费后重试。
400	InvalidParameter	Invalid parameter.	参数不合法。
400	Unauthorized	The AccessKeyId is unauthorized.	账号无权限操作。

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

变更历史

变更时间	变更内容概要	操作
2024-10-28	OpenAPI 错误码发生变更	查看变更详情
2024-07-10	OpenAPI 错误码发生变更	查看变更详情
2023-10-20	OpenAPI 错误码发生变更	查看变更详情
2023-01-03	OpenAPI 错误码发生变更	查看变更详情
2022-12-22	OpenAPI 错误码发生变更	查看变更详情