调用UpdateTransitRouterVbrAttachmentAttribute接口修改企业版转发路由器下VBR连接的配置信息。

使用说明

UpdateTransitRouterVbrAttachmentAttribute接口属于异步接口,即系统会先返回一个RequestId,但该VBR连接并未修改完成,系统后台的修改任务仍在进行。您可以调用ListTransitRouterVbrAttachments接口查询VBR连接的状态。

  • 当VBR连接处于Modifying状态时,表示VBR连接正在修改中,在该状态下,您只能对VBR连接执行查询操作,不能执行其他操作。
  • 当VBR连接处于Attached状态时,表示VBR连接修改完成。

调试

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

请求参数

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

系统规定参数。取值:UpdateTransitRouterVbrAttachmentAttribute

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

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

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

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

VBR连接ID。

TransitRouterAttachmentName String testname

VBR连接的新名称。

名称长度为2~128个字符,以大小写字母或中文开头,可包含数字、下划线(_)和短划线(-)。

TransitRouterAttachmentDescription String testdesc

VBR连接新的描述信息。

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

AutoPublishRouteEnabled Boolean true

是否允许企业版转发路由器向VBR实例中自动发布路由。取值:

  • true:允许。
  • false:禁止。
DryRun Boolean false

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

  • false(默认值):发送正常请求,通过检查后直接修改VBR连接的名称和描述信息。
  • true:发送检查请求,只进行校验,不会修改VBR连接的配置信息。检查项包括是否填写了必需参数、请求格式等。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation

返回数据

名称 类型 示例值 描述
RequestId String 91B36DC3-FF8A-45C3-AC1E-456B1789136D

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=UpdateTransitRouterVbrAttachmentAttribute
&ClientToken=02fb3da4-130e-11e9-8e44-001****
&TransitRouterAttachmentId=tr-attach-oyf70wfuorwx87****
&TransitRouterAttachmentName=testname
&TransitRouterAttachmentDescription=testdesc
&AutoPublishRouteEnabled=true
&DryRun=false
&公共请求参数

正常返回示例

XML格式

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

<UpdateTransitRouterVbrAttachmentAttributeResponse>
    <RequestId>91B36DC3-FF8A-45C3-AC1E-456B1789136D</RequestId>
</UpdateTransitRouterVbrAttachmentAttributeResponse>

JSON格式

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

{
  "RequestId" : "91B36DC3-FF8A-45C3-AC1E-456B1789136D"
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidTransitRouterAttachmentId.NotFound TransitRouterAttachmentId is not found. 网络连接实例ID不存在。

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