全部产品
Search
文档中心

云企业网:CreateTransitRouterVpcAttachment - 在企业版转发路由器下创建专有网络VPC连接

更新时间:Jan 11, 2023

在企业版转发路由器下创建专有网络VPC(Virtual Private Cloud)连接。

接口说明

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

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

    • 当VPC连接处于Attaching状态时,表示VPC连接正在创建中,在该状态下,您只能对VPC连接执行查询操作,不能执行其他操作。
    • 当VPC连接处于Attached状态时,表示VPC连接创建完成。
  • 创建VPC连接后,VPC连接默认不与任何转发路由器路由表建立路由学习关系和关联转发关系。

前提条件

在调用本接口创建VPC连接前,请确保满足以下条件:

  • VPC实例在企业版转发路由器支持的可用区拥有至少一个交换机实例,且该交换机实例拥有至少一个空闲的IP地址。关于企业版转发路由器支持的地域和可用区信息,请参见企业版转发路由器支持的地域和可用区
  • 如果您要连接跨账号的网络实例,请先获得跨账号网络实例授权。具体操作,请参见跨账号网络实例授权
  • VPC连接创建后会产生费用,请确保您已经了解相关计费规则。更多信息,请参见计费说明

调试

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

调试

授权信息

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

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

请求参数

名称 类型 必填 描述 示例值
ClientToken string

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

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

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

云企业网实例ID。

cen-j3jzhw1zpau2km****
TransitRouterId string

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

tr-bp1su1ytdxtataupl****
RegionId string

VPC实例所属地域ID。

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

cn-hangzhou
TransitRouterAttachmentName string

VPC连接的名称。

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

testname
TransitRouterAttachmentDescription string

VPC连接的描述信息。

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

testname
VpcId string

VPC实例ID。

vpc-bp1kbjcre9vtsebo1****
VpcOwnerId long

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

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

付费方式。默认值:POSTPAY,表示按量付费。

POSTPAY
DryRun boolean

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

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

请在企业版转发路由器的可用区中选择一个交换机实例。

一次最多支持添加10组信息。

object

企业版转发路由器支持的可用区及其对应的交换机实例的信息。

VSwitchId string

在企业版转发路由器支持的可用区中选择一个交换机实例。

一次最多支持为10个可用区选择交换机实例。

vsw-bp1a214sbus8z3b54****
ZoneId string

企业版转发路由器支持的可用区的ID。

您可以通过DescribeZones接口查询可用区的ID。

一次最多支持选择10个可用区。

cn-hangzhou-h
Tag array

标签信息。

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

object
Key string

资源的标签键。

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

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

tagtest
Value string

资源的标签值。

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

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

tagtest

返回参数

名称 类型 描述 示例值
object

返回结果。

TransitRouterAttachmentId string

VPC连接ID。

tr-attach-ia340z7xis7t5s****
RequestId string

请求ID。

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

示例

正常返回示例

JSON格式

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

错误码

Http code 错误码 错误信息 描述
400 InvalidStatus.VpcAttachedFullModeCen Operation is invalid because the instance has already attached to other cen with protection level FULL -
400 Forbbiden.AttachChildInstanceAcrossBid Operation is invalid, please apply for cross-bid attaching. 不允许绑定不同bid账号下的vpc。
400 OperationUnsupported.TransitRouterRegionId The specified TransitRouterRegion does not support the operation. 中转地域不支持此操作。
400 NoPermission.AliyunServiceRoleForCEN You are not authorized to create the service linked role. Role Name: AliyunServiceRoleForCEN. Service Name: cen.aliyuncs.com. Make sure that the user has been granted the ram:CreateServiceLinkedRole permission. 您没有权限创建服务关联角色,角色名:AliyunServiceRoleForCEN,服务名:cen.aliyuncs.com。请确保已授予当前用户ram:CreateServiceLinkedRole权限。
400 IllegalParam.RegionId The Specified Parameter RegionId is illegal 参数中指定的Region不合法。
400 MissingParam.CenIdOrRegionId Either CenId or RegionId must be specified. CenId或者RegionId是必选参数。
400 IllegalParam.ZoneId The specified ZoneId is illegal. 传入的可用区非法
400 IllegalParam.ChargeType The specified ChargeType is illegal. 付费类型非法
400 InvalidTransitRouterId.NotFound The specified TransitRouterId is not found. 指定的转发路由器不存在
400 IncorrectStatus.VpcResource The resource is not in a valid state for the attachment operation. 当前vpc资源不处于稳态,无法进行该操作,请等待与当前vpc相关操作结束后重试。
400 IncorrectStatus.Vpc The resource is not in a valid state for the attachment operation. 当前vpc的状态不支持该操作,请稍后重试。
400 IncorrectStatus.VpcOrVswitch The Vpc Or Vswith is not in a valid state for the attachment operation. 当前vpc或vswitch的状态不支持该操作,请稍后重试。
400 OperationNotSupport.VpcAutoRoutesPublish Auto publish vpc routes is not supported in this region. 当前地域暂不支持vpc路由自动发布。
400 InvalidOperation.VpcAutoRoutesPublishInOtherCEN The operation is not supported because the VPC is already set autoRoutesPublish in other CEN. 当前vpc已经在其他CEN中开启了路由自动同步,无法支持该操作。
400 QuotaExceeded.VpcAutoRoutesPublishPerTransitRouter The count of VPC instance which set autoRoutesPublish in transitRouter is over limit. 开启路由自动同步的vpc数量已达到上限。
400 InvalidOperation.VpnAssociated The operation is not supported because the VPC is associated with VPN. 当前vpc与vpn绑定,无法打开路由自动同步功能。
400 Forbbiden.TransitRouterServiceNotOpen The user has not open transit router service. 转发路由器服务未打开,请打开后重试。
400 IllegalParam.ZoneMappings The Specified Parameter ZoneMappings is illegal 参数中指定的ZoneMappings不合法。
400 OperationUnsupported.TransitRouterType The specified TransitRouterType does not support the operation. 当前TransitRouter类型不支持该操作。
400 InvalidCenId.NotFound CenId is not found. CEN实例不存在。
400 IllegalParam.VSwitchId VSwitchId is illegal. 参数中指定的VSwitchId不合法。
400 InvalidVSwitchId.NotFound VSwitchId is not found. -
400 IllegalParam.RegionId RegionId is illegal. 参数中指定的Region不合法。
400 IncorrectStatus.TransitRouterInstance The status of TransitRouter is incorrect. 转发路由器状态不正确。
400 OperationUnsupported.CenFullLevel CEN full level does not support TransitRouter Full类型CEN不支持创建企业版转发路由器。
400 IllegalParam.ServiceMode ServiceMode is illegal. ServiceMode不合法。
400 QuotaFull.ChildInstanceRelatedCen The childinstance has exceed the quota of the times that a childinstance can be attached as an attachment. 该实例绑定CEN数量已达到上限,无法加载。
400 OperationUnsupported.CloudBoxVswNotSupport Cloud Box vsw does not support. 云盒的vsw不允许加载。
400 IncorrectStatus.TransitRouter The status of TransitRouter is incorrect. 当前TransitRouter的状态不支持该操作,请稍后重试。
400 Duplicated.ZoneMapping The parameter ZoneMapping is duplicated. ZoneMapping中存在重复的条目。
409 InvalidOperation.CenInstanceStatus The CEN instance is not in a valid state for the operation. -

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

变更历史

变更时间 变更内容概要 操作
2023-01-04 OpenAPI 错误码发生变更
变更项 变更内容
错误码 OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:409
2022-12-22 OpenAPI 错误码发生变更
变更项 变更内容
错误码 OpenAPI 错误码发生变更
    错误码400变更
    新增错误码:409
2022-10-19 OpenAPI 错误码发生变更,OpenAPI 入参发生变更
变更项 变更内容
错误码 OpenAPI 错误码发生变更
    删除错误码:400
入参 OpenAPI 入参发生变更
    删除入参:AutoPublishRouteEnabled