全部产品
Search
文档中心

云企业网:UpdateTransitRouterVpcAttachmentAttribute - 修改转发路由器下VPC连接信息

更新时间:Mar 01, 2024

调用UpdateTransitRouterVpcAttachmentAttribute接口修改企业版转发路由器下VPC连接的名称和描述信息以及是否需要使企业版转发路由器自动发布路由到 VPC 实例。

接口说明

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

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cen:UpdateTransitRouterVpcAttachmentAttributeWrite
  • TransitRouterVpcAttachment
    acs:cen:*:{#accountId}:centransitrouterattachment/{#centransitrouterattachmentId}

请求参数

名称类型必填描述示例值
ClientTokenstring

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

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

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
02fb3da4-130e-11e9-8e44-001****
TransitRouterAttachmentIdstring

VPC 连接 ID。

tr-attach-nls9fzkfat8934****
TransitRouterAttachmentNamestring

VPC 连接的名称。

名称可以为空或长度为 1~128 个字符,不能以 http://或 https://开头。

testname
TransitRouterAttachmentDescriptionstring

VPC 连接的描述信息。

描述可以为空或长度为 1~256 个字符,不能以 http://或 https://开头。

testdesc
DryRunboolean

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

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

是否允许企业版转发路由器自动发布路由到 VPC 实例。

  • false:否。
  • true:是。
true

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

7E61D334-4025-41EF-9145-FC327B35301D

示例

正常返回示例

JSON格式

{
  "RequestId": "7E61D334-4025-41EF-9145-FC327B35301D"
}

错误码

HTTP status code错误码错误信息描述
400IncorrectStatus.TransitRouterAttachmentIdTransitRouterAttachmentId status is invalid.当前TransitRouterAttachment的状态不支持该操作,请稍后重试。
400InvalidTransitRouterAttachmentId.NotFoundTransitRouterAttachmentId is not found.网络连接实例ID不存在。
400InvalidOperation.RegionNotSupportThe operation is not supported in this region.当前地域不支持该操作。
400InvalidOperation.VpcAutoRoutesPublishInOtherCENThe operation is not supported because the VPC is already set autoRoutesPublish in other CEN.-
400QuotaExceeded.VpcAutoRoutesPublishPerTransitRouterThe count of VPC instance which set autoRoutesPublish in transitRouter is over limit.-
400InvalidOperation.VpnAssociatedThe operation is not supported because the VPC is associated with VPN.当前VPC与VPN绑定,无法打开路由自动同步功能。
400InvalidParameterInvalid parameter.参数不合法。
400UnauthorizedThe AccessKeyId is unauthorized.账号无权限操作。

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

变更历史

变更时间变更内容概要操作
2022-10-19OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    删除入参:AutoPublishRouteEnabled