CreateTransitRouterCidr-阿里云帮助中心

使用说明

转发路由器地址段是您为转发路由器自定义的一个地址段，该地址段类似于为路由器环回口（Loopback接口）分配IP地址的地址段。转发路由器地址段被用于为网络实例连接分配地址。更多信息，请参见转发路由器地址段。

CreateTransitRouterCidr接口仅适用于在您创建转发路由器后，为转发路由器添加地址段。

在您创建转发路由器地址段前，请了解以下信息：

仅企业版转发路由器支持配置转发路由器地址段。
转发路由器地址段功能正在公测中，仅在部分地域开放。关于已开放的地域详情，请参见转发路由器地址段使用限制。
一个转发路由器最多支持配置5个地址段。每个地址段的子网掩码位数不能少于16位，且不能超过24位。
不支持创建100.64.0.0/10、224.0.0.0/4、127.0.0.0/8、169.254.0.0/16及其子网的地址段。
每个地址段不能与云企业网实例下所有待互通的网段冲突。
同一个云企业网实例下，每个地址段需确保唯一。
为转发路由器添加地址段后，您在转发路由器下创建第一个VPN连接时，系统将自动从地址段中划分出三个网段作为系统保留网段，用于系统后台创建VPN连接，且系统将从地址段剩余的网段中为IPsec连接分配IP地址。

您可以调用ListTransitRouterCidrAllocation接口查询系统已保留或者已分配IP地址的网段信息。

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	CreateTransitRouterCidr	系统规定参数。取值：CreateTransitRouterCidr。
ClientToken	String	否	123e4567-e89b-12d3-a456-426****	客户端Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。说明若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
TransitRouterId	String	是	tr-p0w3x8c9em72a40nw****	转发路由器实例ID。
RegionId	String	是	ap-southeast-2	转发路由器实例所属地域ID。您可以通过调用DescribeChildInstanceRegions接口获取地域ID。
Name	String	否	nametest	转发路由器地址段的名称。名称长度为2~128个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-），但不能以`http://`或`https://`开头。
Description	String	否	desctest	转发路由器地址段的描述信息。描述长度为2~256个字符，必须以字母或中文开头，但不能以`http://`或`https://`开头。
DryRun	Boolean	否	false	是否只预检此次请求。取值： true：发送检查请求，不会创建转发路由器地址段。检查项包括是否填写了必需参数、请求格式、业务限制等。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。 false（默认值）：发送正常请求，通过检查后直接创建转发路由器地址段。
Cidr	String	是	192.168.10.0/24	转发路由器地址段。
PublishCidrRoute	Boolean	否	true	是否允许系统自动在转发路由器路由表中添加转发路由器地址段的路由。 true（默认值）：允许。如果您选择了允许，则在您创建了私网网关类型的VPN连接，并为私网网关类型的VPN连接创建了路由学习关系后，系统自动在与VPN连接建立路由学习关系的转发路由器路由表中添加一条路由条目：目标网段为转发路由器地址段的黑洞路由，其中转发路由器地址段指已为IPsec连接分配网关IP地址的地址段。该黑洞路由仅会被传播至转发路由器下VBR实例的路由表中。 false：不允许。

返回数据


名称	类型	示例值	描述
TransitRouterCidrId	String	cidr-0zv0q9crqpntzz****	转发路由器地址段ID。
RequestId	String	0876E54E-3E36-5C31-89F0-9EE8A9266F9A	请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateTransitRouterCidr
&ClientToken=123e4567-e89b-12d3-a456-426****
&TransitRouterId=tr-p0w3x8c9em72a40nw****
&RegionId=ap-southeast-2
&Name=nametest
&Description=desctest
&DryRun=false
&Cidr=192.168.10.0/24
&PublishCidrRoute=true
&公共请求参数

正常返回示例

XML格式

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

<CreateTransitRouterCidrResponse>
    <TransitRouterCidrId>cidr-0zv0q9crqpntzz****</TransitRouterCidrId>
    <RequestId>0876E54E-3E36-5C31-89F0-9EE8A9266F9A</RequestId>
</CreateTransitRouterCidrResponse>

JSON格式

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

{
  "TransitRouterCidrId" : "cidr-0zv0q9crqpntzz****",
  "RequestId" : "0876E54E-3E36-5C31-89F0-9EE8A9266F9A"
}

错误码

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