调用UpdateTransitRouter接口修改转发路由器实例的名称和描述信息。

使用说明

UpdateTransitRouter接口属于异步接口,即系统会先返回一个RequestId,但转发路由器实例的修改并未完成,系统后台的修改任务仍在进行。您可以调用ListTransitRouters接口查询转发路由器实例的状态。

  • 当转发路由器实例处于Modifying状态时,表示转发路由器实例正在修改中,在该状态下,您只能对转发路由器实例执行查询操作,不能执行其他操作。
  • 当转发路由器实例处于Active状态时,表示转发路由器实例修改完成。

调试

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

请求参数

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

系统规定参数。取值:UpdateTransitRouter

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

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

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

说明 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
DryRun Boolean false

是否对此次修改请求执行预检,包括权限、实例状态校验等。取值:

  • false(默认):发送正常请求,通过检查后直接修改转发路由器实例的信息。
  • true:发送检查请求,只进行校验,不会修改转发路由器实例的信息。检查项包括是否填写了必需参数、请求格式等。如果检查不通过,则返回对应错误。如果检查通过,则返回对应请求ID。
RegionId String cn-shanghai

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

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

TransitRouterId String tr-uf654ttymmljlvh2x****

转发路由器实例ID。

TransitRouterName String testname

转发路由器实例的新名称。

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

TransitRouterDescription String testdesc

转发路由器实例新的描述信息。

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

返回数据

名称 类型 示例值 描述
RequestId String E9963DD7-998B-4F92-892D-8293CB49EE81

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=UpdateTransitRouter
&ClientToken=02fb3da4-130e-11e9-8e44-001****
&DryRun=false
&RegionId=cn-shanghai
&TransitRouterId=tr-uf654ttymmljlvh2x****
&TransitRouterName=testname
&TransitRouterDescription=testdesc
&公共请求参数

正常返回示例

XML格式

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

<UpdateTransitRouterResponse>
    <RequestId>E9963DD7-998B-4F92-892D-8293CB49EE81</RequestId>
</UpdateTransitRouterResponse>

JSON格式

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

{
  "RequestId" : "E9963DD7-998B-4F92-892D-8293CB49EE81"
}

错误码

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