全部产品
Search
文档中心

云企业网:CreateTransitRouterVbrAttachment - 在企业版转发路由器下创建边界路由器VBR连接

更新时间:Mar 01, 2024

您可以调用CreateTransitRouterVbrAttachment接口将要互通的边界路由器VBR(Virtual Border Router)网络实例连接到同地域的转发路由器实例中。连接后,转发路由器可帮您实现私网互通。

接口说明

  • 企业版转发路由器支持的地域和可用区信息,请参见什么是云企业网

  • 您可以通过以下两种方式在企业版转发路由器下创建 VBR 连接:

    • 如果您已经在目标地域创建了企业版转发路由器实例,您可以通过指定 VbrIdRegionIdTransitRouterId 创建 VBR 连接。
    • 如果您在目标地域没有企业版转发路由器实例,您可以通过指定 VbrIdCenIdRegionId 创建 VBR 连接。创建 VBR 连接时系统为您自动创建企业版转发路由器实例。
  • CreateTransitRouterVbrAttachment 接口属于异步接口,即系统会先返回一个 VBR 连接 ID,但该 VBR 连接并未创建完成,系统后台的创建任务仍在进行。您可以调用 ListTransitRouterVbrAttachments 接口查询 VBR 连接的状态。

    • 当 VBR 连接处于 Attaching 状态时,表示 VBR 连接正在创建中,在该状态下,您只能对 VBR 连接执行查询操作,不能执行其他操作。
    • 当 VBR 连接处于 Attached 状态时,表示 VBR 连接创建完成。
  • 转发路由器所属的阿里云账号和 VBR 实例所属的阿里云账号属于同一家企业。

  • 转发路由器支持连接同账号和跨账号的 VBR 实例。在创建跨账号的 VBR 连接前,请先获得跨账号 VBR 实例的授权。具体操作,请参见跨账号网络实例授权

  • 创建 VBR 连接后,VBR 连接默认不与任何转发路由器路由表建立路由学习关系和关联转发关系。

调试

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

授权信息

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

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

请求参数

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

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

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

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

云企业网实例 ID。

cen-j3jzhw1zpau2km****
TransitRouterIdstring

企业版转发路由器实例 ID。

tr-bp1su1ytdxtataupl****
RegionIdstring

VBR 实例所属地域 ID。

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

cn-hangzhou
TransitRouterAttachmentNamestring

VBR 连接名称。

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

testname
TransitRouterAttachmentDescriptionstring

VBR 连接描述。

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

testdesc
VbrIdstring

VBR 实例 ID。

vbr-bp1svadp4lq38janc****
VbrOwnerIdlong

VBR 实例所属阿里云账号(主账号)ID。默认值为当前登录的阿里云账号 ID。

说明 如果您要加载跨账号的网络实例,本参数必填。
1250123456123456
AutoPublishRouteEnabledboolean

是否使企业版转发路由器自动发布路由到 VBR 实例。

  • false(默认值):否。
  • true:是。
false
DryRunboolean

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

  • false(默认值):发送正常请求,通过检查后直接创建 VBR 连接。
  • true:发送检查请求,只进行校验,不会创建 VBR 连接。检查项包括是否填写了必需参数、请求格式等。如果检查不通过,则返回对应错误。如果检查通过,则返回对应请求 ID。
false
Tagobject []

标签信息。

一次最多支持输入 20 个标签信息。

Keystring

资源的标签键。

一旦传入该值,则不允许为空字符串。最多支持 64 个字符,不能以aliyun或者acs:开头,不能包含http://或者https://

一次最多支持输入 20 个标签的标签键。

TagKey
Valuestring

资源的标签值。

标签值可以为空或输入不超过 128 个字符的字符串,不能以aliyun或者acs:开头,不能包含http://或者https://

每一个标签键对应一个标签值,一次最多支持输入 20 个标签键对应的标签值。

TagValue

返回参数

名称类型描述示例值
object

返回结果。

TransitRouterAttachmentIdstring

VBR 连接 ID。

tr-attach-ia340z7xis7t5s****
RequestIdstring

请求 ID。

C087A369-82B9-43EF-91F4-4B63A9C6E6B6

示例

正常返回示例

JSON格式

{
  "TransitRouterAttachmentId": "tr-attach-ia340z7xis7t5s****",
  "RequestId": "C087A369-82B9-43EF-91F4-4B63A9C6E6B6"
}

错误码

HTTP status code错误码错误信息描述
400NoPermission.AliyunServiceRolePolicyForCENYou are not authorized to create the service linked role. Role Name: AliyunServiceRolePolicyForCEN. Service Name: cen.aliyuncs.com. Make sure that the user has been granted the ram:CreateServiceLinkedRole permission.您没有权限创建服务关联角色,角色名:AliyunServiceRolePolicyForCEN,服务名:cen.aliyuncs.com。请确保已授予当前用户ram:CreateServiceLinkedRole权限。
400OperationUnsupported.TransitRouterRegionIdThe specified TransitRouterRegion does not support the operation.中转地域不支持此操作。
400InvalidCenId.NotFoundCenId is not found.CEN实例不存在。
400InvalidStatus.ResourceStatusThe resource is not in a valid state for the attachment operation.当前资源状态不支持该操作,请稍后重试。
400InvalidTransitRouterId.NotFoundTransitRouterId is not found.转发路由实例ID不存在。
400Forbbiden.TransitRouterServiceNotOpenThe user has not open transit router service.转发路由器服务未打开,请打开后重试。
400OperationUnsupported.TransitRouterTypeThe specified TransitRouterType does not support the operation.当前TransitRouter类型不支持该操作。
400MissingParam.CenIdOrRegionIdEither CenId or RegionId must be specified.CenId或者RegionId是必选参数。
400IncorrectStatus.VpcThe resource is not in a valid state for the attachment operation.当前VPC的状态不支持该操作,请稍后重试。
400Forbidden.VbrDeviceModelAttach VBR on some access device models are forbidden.vbr当前接入模式不支持该操作。
400IllegalParam.AssociateRouteTableIdThe specified AssociateRouteTableId is illegal.参数中指定的AssociateRouteTableId不合法。
400Forbbiden.AttachChildInstanceAcrossBidOperation is invalid, please apply for cross-bid attaching.-
400IllegalParam.RegionIdRegionId is illegal.参数中指定的Region不合法。
400OperationUnsupported.CenFullLevelCEN full level does not support TransitRouterFull类型CEN不支持创建企业版转发路由器。
400OperationUnsupported.VbrAttachmentThis region not support vbr attachment.该地域不支持加载vbrAttachment。
400InvalidOperation.CenInstanceStatusThe CEN instance is not in a valid state for the operation. -
400OperationUnsupported.CloudBoxVbrNotSupportCloud Box Vbr does not support.云盒实例不允许加载。
400IncorrectStatus.VbrResourceThe resource is not in a valid state for the attachment operation.当前vbr资源不处于稳态,无法进行该操作,请等待与当前vbr相关操作结束后重试。
400IncorrectStatus.TransitRouterThe status of TransitRouter is incorrect.当前TransitRouter的状态不支持该操作,请稍后重试。
400QuotaExceeded.CenQuotaVbrAttachPerTransitRouterThe maximum number of VBR attachment per Transit Router is exceeded.每个转发路由器支持连接的边界路由器VBR个数超限,可提交工单提升额度。
400QuotaFull.ChildInstanceRelatedCenThe childinstance has exceed the quota of the times that a childinstance can be attached as an attachment.该实例绑定CEN数量已达到上限,无法加载。
400Forbidden.ResourceOwnerTransitRouterServiceNotOpenThe resource owner user has not opened transit router service.资源所属账号转发路由器服务未开通,请通知对方开通后重试。
400InvalidParameterInvalid parameter.参数不合法。
400UnauthorizedThe AccessKeyId is unauthorized.账号无权限操作。
403Forbidden.VbrDeviceModelThe attached VBR on some access device models are not supported. Please submit a ticket to continue using this VBR on CEN.Vbr当前接入模式不支持该操作。

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

变更历史

变更时间变更内容概要操作
2024-01-10OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
2023-10-20OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
2023-01-04OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
2022-12-22OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403