文档

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

更新时间:

调用CreateTransitRouterVpcAttachment接口将要互通的专有网络VPC(Virtual Private Cloud)实例连接至转发路由器实例。连接后,转发路由器实例可以帮助您实现私网互通。

接口说明

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

    • 如果您已经在目标地域创建了企业版转发路由器实例,您可以通过指定 VpcIdZoneMappings.N.VSwitchIdZoneMappings.N.ZoneIdTransitRouterIdRegionId 创建 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:CreateTransitRouterVpcAttachmentWrite
  • 全部资源
    *

请求参数

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

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

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

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

云企业网实例 ID。

cen-j3jzhw1zpau2km****
TransitRouterIdstring

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

tr-bp1su1ytdxtataupl****
RegionIdstring

VPC 实例所属地域 ID。

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

cn-hangzhou
TransitRouterAttachmentNamestring

VPC 连接的名称。

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

testname
TransitRouterAttachmentDescriptionstring

VPC 连接的描述信息。

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

testname
VpcIdstring

VPC 实例 ID。

vpc-bp1kbjcre9vtsebo1****
VpcOwnerIdlong

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

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

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

POSTPAY
DryRunboolean

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

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

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

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

VSwitchIdstring

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

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

vsw-bp1a214sbus8z3b54****
ZoneIdstring

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

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

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

cn-hangzhou-h
AutoPublishRouteEnabledboolean

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

  • false(默认值):否。
  • true:是。
true
Tagobject []

标签信息。

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

Keystring

资源的标签键。

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

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

tagtest
Valuestring

资源的标签值。

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

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

tagtest

返回参数

名称类型描述示例值
object

返回结果。

TransitRouterAttachmentIdstring

VPC 连接 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错误码错误信息描述
400OperationUnsupported.TransitRouterRegionIdThe specified TransitRouterRegion does not support the operation.中转地域不支持此操作。
400NoPermission.AliyunServiceRoleForCENYou 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权限。
400IllegalParam.RegionIdThe Specified Parameter RegionId is illegal参数中指定的Region不合法。
400MissingParam.CenIdOrRegionIdEither CenId or RegionId must be specified.CenId或者RegionId是必选参数。
400IllegalParam.ZoneIdThe specified ZoneId is illegal.传入的可用区非法
400IllegalParam.ChargeTypeThe specified ChargeType is illegal.付费类型非法
400InvalidTransitRouterId.NotFoundThe specified TransitRouterId is not found.指定的转发路由器不存在
400IncorrectStatus.VpcResourceThe resource is not in a valid state for the attachment operation.当前VPC资源不处于稳态,无法进行该操作,请等待与当前VPC相关操作结束后重试。
400IncorrectStatus.VpcThe resource is not in a valid state for the attachment operation.当前VPC的状态不支持该操作,请稍后重试。
400IncorrectStatus.VpcOrVswitchThe Vpc Or Vswith is not in a valid state for the attachment operation.当前vpc或vswitch的状态不支持该操作,请稍后重试。
400OperationNotSupport.VpcAutoRoutesPublishAuto publish vpc routes is not supported in this region.当前地域暂不支持vpc路由自动发布。
400InvalidOperation.VpnAssociatedThe operation is not supported because the VPC is associated with VPN.当前VPC与VPN绑定,无法打开路由自动同步功能。
400Forbbiden.TransitRouterServiceNotOpenThe user has not open transit router service.转发路由器服务未打开,请打开后重试。
400IllegalParam.ZoneMappingsThe Specified Parameter ZoneMappings is illegal参数中指定的ZoneMappings不合法。
400OperationUnsupported.TransitRouterTypeThe specified TransitRouterType does not support the operation.当前TransitRouter类型不支持该操作。
400InvalidCenId.NotFoundCenId is not found.CEN实例不存在。
400IllegalParam.VSwitchIdVSwitchId is illegal.参数中指定的VSwitchId不合法。
400IllegalParam.RegionIdRegionId is illegal.参数中指定的Region不合法。
400IncorrectStatus.TransitRouterInstanceThe status of TransitRouter is incorrect.转发路由器状态不正确。
400OperationUnsupported.CenFullLevelCEN full level does not support TransitRouterFull类型CEN不支持创建企业版转发路由器。
400IllegalParam.ServiceModeServiceMode is illegal.ServiceMode不合法。
400QuotaFull.ChildInstanceRelatedCenThe childinstance has exceed the quota of the times that a childinstance can be attached as an attachment.该实例绑定CEN数量已达到上限,无法加载。
400OperationUnsupported.CloudBoxVswNotSupportCloud Box vsw does not support.云盒的vsw不允许加载。
400IncorrectStatus.TransitRouterThe status of TransitRouter is incorrect.当前TransitRouter的状态不支持该操作,请稍后重试。
400Duplicated.ZoneMappingThe parameter ZoneMapping is duplicated.ZoneMapping中存在重复的条目。
400QuotaExceeded.CenQuotaVpcAttachPerTransitRouterThe maximum number of VPC attachment per Transit Router is exceeded.每个转发路由器支持连接的专有网络VPC个数超限。
400IncorrectStatus.VpcRouteTableThe VPC route table is not in a desired state.该操作相关的VPC路由表不处于稳态,无法操作,请稍后重试。
400InvalidStatus.VpcAttachedFullModeCenThe VPC has been attached to another CEN instance whose protection level is FULL.参数中指定的vpc加载到另一个protection level为FULL的cen中,无法再加载到其他cen中。
400Forbbiden.AttachChildInstanceAcrossBidVPCs that belong to another BID cannot be associated. You need to apply for cross-BID attaching.不允许绑定不同bid账号下的VPC。
400InvalidOperation.VpcAutoRoutesPublishInOtherCENThe specified VPC already has its routes synchronized with another CEN instance.当前VPC已经在其他CEN中开启了路由自动同步,无法支持该操作。
400QuotaExceeded.VpcAutoRoutesPublishPerTransitRouterThe number of VPCs that have route synchronization enabled has reached the upper limit.开启路由自动同步的VPC数量已达到上限。
400InsufficientIpAddr.vswInsufficient available IP addresses in the vSwitch.虚拟交换机中的可用IP数目不足
400Forbidden.ResourceOwnerTransitRouterServiceNotOpenThe resource owner user has not opened transit router service.资源所属账号转发路由器服务未开通,请通知对方开通后重试。
400IllegalParam.TransitRouterRegionIdTransitRouterRegionId is illegal.TransitRouterRegionId不合法。
400InvalidTransitRouterMode.NeedUpgradeTransitRouter need to upgrade.当前转发路由器模式不支持。
400IllegalParam.Ipv6SupportIpv6Support is illegal. Valid Values are [enable, disable].请求参数Ipv6Support值非法,有效值为enable或disable。
400OperationFailed.VSwitchNotFoundThe specified vswitch not found.指定的VSwitchId不存在,请确认该VSwitch状态是否可用或指定其他可用的VSwitch。
400OperationFailed.VSwitchIpv6CidrNotAllocatedThe specified vswitch does not have IPv6 address allocated.指定的VSwitch未开通Ipv6,请开通Ipv6后再进行该操作。
400InvalidParameterInvalid parameter.参数不合法。
400UnauthorizedThe AccessKeyId is unauthorized.账号无权限操作。
404InvalidVSwitchId.NotFoundThe specified VSwitchId is not found.指定的VSwitchId不存在。
409InvalidOperation.CenInstanceStatusThe CEN instance is not in a valid state for the operation.cen当前状态不支持该操作,请稍后重试。
409IncorrectStatus.VpcSwitchThe resource is not in a valid state for the attachment operation.当前Vswitch的状态不支持该操作,请稍后重试。

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

变更历史

变更时间变更内容概要操作
2024-04-19OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:404
    删除错误码:409
2024-03-13OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:404
    删除错误码:409
2024-01-10OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:404
    删除错误码:409
2023-09-08OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 409 变更
    删除错误码:400
    删除错误码:404
2023-03-14OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:404
    删除错误码:409
2023-01-04OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:409
2022-12-22OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    新增错误码:409
2022-10-19OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    删除入参:AutoPublishRouteEnabled
  • 本页导读 (1)