调用ModifyTransitRouterCidr接口修改转发路由器地址段。

使用说明

  • 在您修改转发路由器地址段前，建议您先了解转发路由器地址段使用限制。
  • 已经分配地址的转发路由器地址段不支持修改。
  • 调用ModifyTransitRouterCidr接口时如果不涉及PublishCidrRoute参数修改，当前接口为同步接口，修改后立即生效。
  • 调用ModifyTransitRouterCidr接口时如果涉及PublishCidrRoute参数修改，当前接口为异步接口，即系统会先返回一个RequestId，但转发路由器地址段并未修改完成，系统后台的修改任务仍在进行。您可以调用ListTransitRouterCidr接口查询转发路由器地址段的修改状态。
    • 如果转发路由器地址段依旧为修改前的信息，则表示转发路由器地址段在修改中。
    • 如果转发路由器地址段为修改后的信息，则表示转发路由器地址段已修改成功。

调试

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

请求参数

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

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

ClientToken String 否 123e4567-e89b-12d3-a456-426****

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

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

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

转发路由器实例ID。
TransitRouterCidrId String 是 cidr-0zv0q9crqpntzz****

转发路由器地址段ID。

您可以通过调用ListTransitRouterCidr接口查询转发路由器地址段ID。

RegionId String 是 ap-southeast-2

转发路由器实例所属的地域ID。

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

Name String 否 nametest

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

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

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

描述长度为1~256个字符。
Cidr String 否 192.168.10.0/24

新的转发路由器地址段。
DryRun Boolean 否 false

是否只预检此次请求。取值：

  • true：发送检查请求，不会修改转发路由器地址段。检查项包括是否填写了必需参数、请求格式、业务限制等。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。
  • false（默认值）：发送正常请求，通过检查后直接修改转发路由器地址段。
PublishCidrRoute Boolean 否 true

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

  • true：允许。

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

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

    该黑洞路由仅会被传播至转发路由器下VBR实例的路由表中。

  • false：不允许。

返回数据

名称 类型 示例值 描述
RequestId String 0876E54E-3E36-5C31-89F0-9EE8A9266F9A

请求ID。

示例

请求示例

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

正常返回示例

XML格式 

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

<ModifyTransitRouterCidrResponse>
    <RequestId>0876E54E-3E36-5C31-89F0-9EE8A9266F9A</RequestId>
</ModifyTransitRouterCidrResponse>

JSON格式 

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

{
  "RequestId" : "0876E54E-3E36-5C31-89F0-9EE8A9266F9A"
}

错误码

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