调用UpdateTransitRouterVbrAttachmentAttribute接口修改企业版转发路由器下VBR连接的名称、描述信息、是否允许自动发布路由。
接口说明
UpdateTransitRouterVbrAttachmentAttribute 接口属于异步接口,即系统会先返回一个 RequestId,但该 VBR 连接并未修改完成,系统后台的修改任务仍在进行。您可以调用 ListTransitRouterVbrAttachments 接口查询 VBR 连接的状态。
- 当 VBR 连接处于 Modifying 状态时,表示 VBR 连接正在修改中,在该状态下,您只能对 VBR 连接执行查询操作,不能执行其他操作。
- 当 VBR 连接处于 Attached 状态时,表示 VBR 连接修改完成。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
cen:UpdateTransitRouterVbrAttachmentAttribute |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClientToken | string | 否 | 客户端 Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 说明
若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
| 02fb3da4-130e-11e9-8e44-001**** |
TransitRouterAttachmentId | string | 是 | VBR 连接 ID。 | tr-attach-oyf70wfuorwx87**** |
TransitRouterAttachmentName | string | 否 | VBR 连接的新名称。 名称可以为空或长度为 1~128 个字符,不能以 http://或 https://开头。 | testname |
TransitRouterAttachmentDescription | string | 否 | VBR 连接新的描述信息。 描述可以为空或长度为 1~256 个字符,不能以 http://或 https://开头。 | testdesc |
AutoPublishRouteEnabled | boolean | 否 | 是否允许企业版转发路由器向 VBR 实例中自动发布路由。取值:
| true |
DryRun | boolean | 否 | 是否对此次请求执行预检,包括权限、实例状态校验等。取值:
| false |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "91B36DC3-FF8A-45C3-AC1E-456B1789136D"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidTransitRouterAttachmentId.NotFound | TransitRouterAttachmentId is not found. | 网络连接实例ID不存在。 |
400 | IncorrectStatus.TransitRouterAttachment | The status of TransitRouterAttachment is incorrect. | 当前TransitRouterAttachment的状态不支持该操作,请稍后重试。 |
400 | InvalidParameter | Invalid parameter. | 参数不合法。 |
400 | Unauthorized | The AccessKeyId is unauthorized. | 账号无权限操作。 |
访问错误中心查看更多错误码。