转发路由器地址段是您为转发路由器自定义的一个地址段,该地址段类似于为路由器环回口(Loopback接口)分配IP地址的地址段。您可以调用CreateTransitRouterCidr接口创建转发路由器下CIDR地址段。
接口说明
转发路由器地址段是您为转发路由器自定义的一个地址段,该地址段类似于为路由器环回口(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代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
cen:CreateTransitRouterCidr | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClientToken | string | 否 | 客户端 Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 说明
若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
| 123e4567-e89b-12d3-a456-426**** |
TransitRouterId | string | 是 | 转发路由器实例 ID。 | tr-p0w3x8c9em72a40nw**** |
RegionId | string | 是 | 转发路由器实例所属地域 ID。 您可以通过调用 DescribeChildInstanceRegions 接口获取地域 ID。 | cn-hangzhou |
Name | string | 否 | 转发路由器地址段的名称。 名称可以为空或长度为 1~128 个字符,不能以 http://或 https://开头。 | nametest |
Description | string | 否 | 转发路由器地址段的描述信息。 描述可以为空或长度为 1~256 个字符,不能以 http://或 https://开头。 | desctest |
DryRun | boolean | 否 | 是否只预检此次请求。取值:
| false |
Cidr | string | 是 | 转发路由器地址段。 | 192.168.10.0/24 |
PublishCidrRoute | boolean | 否 | 是否允许系统自动在转发路由器路由表中添加转发路由器地址段的路由。
| true |
返回参数
示例
正常返回示例
JSON
格式
{
"TransitRouterCidrId": "cidr-0zv0q9crqpntzz****",
"RequestId": "0876E54E-3E36-5C31-89F0-9EE8A9266F9A"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | OverLappingExist.Cidr | The cidr overlapping exist. | cidr overlapping已存在。 |
400 | OperationUnsupported.TransitRouterCidr | Transit region does not support the operation. | 当前地域不支持该操作。 |
400 | IllegalParam.Cidr | The specified cidr is invalid. | 参数中指定的cidr不合法。 |
400 | IllegalParam.RegionId | The specified RegionId is illegal. | 参数中指定的Region不合法。 |
400 | InstanceNotExist | The instance is not exist. | 指定实例不存在。 |
400 | InvalidTransitRouterMode.NeedUpgrade | TransitRouter need to upgrade. | 当前转发路由器模式不支持。 |
400 | InvalidParameter | Invalid parameter. | 参数不合法。 |
400 | Unauthorized | The AccessKeyId is unauthorized. | 账号无权限操作。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-07-26 | OpenAPI 错误码发生变更 | 查看变更详情 |
2024-01-18 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-03-09 | OpenAPI 错误码发生变更 | 查看变更详情 |