调用CreateTransitRouterVpcAttachment接口在企业版转发路由器下创建专有网络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代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateTransitRouterVpcAttachment

系统规定参数。取值:CreateTransitRouterVpcAttachment

ClientToken String 02fb3da4-130e-11e9-8e44-001****

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

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

说明 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
CenId String cen-j3jzhw1zpau2km****

云企业网实例ID。

TransitRouterId String tr-bp1su1ytdxtataupl****

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

RegionId String cn-hangzhou

VPC实例所属地域ID。

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

TransitRouterAttachmentName String testname

VPC连接的名称。

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

TransitRouterAttachmentDescription String testname

VPC连接的描述信息。

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

VpcId String vpc-bp1kbjcre9vtsebo1****

VPC实例ID。

VpcOwnerId Long 1250123456123456

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

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

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

DryRun Boolean false

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

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

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

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

ZoneMappings.N.ZoneId String cn-hangzhou-h

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

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

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

返回数据

名称 类型 示例值 描述
TransitRouterAttachmentId String tr-attach-ia340z7xis7t5s****

VPC连接ID。

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

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateTransitRouterVpcAttachment
&ClientToken=02fb3da4-130e-11e9-8e44-001****
&CenId=cen-j3jzhw1zpau2km****
&TransitRouterId=tr-bp1su1ytdxtataupl****
&RegionId=cn-hangzhou
&TransitRouterAttachmentName=testname
&TransitRouterAttachmentDescription=testname
&VpcId=vpc-bp1kbjcre9vtsebo1****
&VpcOwnerId=1250123456123456
&ChargeType=POSTPAY
&DryRun=false
&ZoneMappings=[{"VSwitchId":"vsw-bp1a214sbus8z3b54****","ZoneId":"cn-hangzhou-h"}]
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateTransitRouterVpcAttachmentResponse> 
<TransitRouterAttachmentId>tr-attach-ia340z7xis7t5s****</TransitRouterAttachmentId>
<RequestId>C087A369-82B9-43EF-91F4-4B63A9C6E6B6</RequestId>
</CreateTransitRouterVpcAttachmentResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode 错误码 错误信息 描述
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 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.Attachment The resource is not in a valid state for the attachment operation. 网络连接实例正在处理状态,请稍后再操作。
400 IncorrectStatus.Vpc The resource is not in a valid state for the attachment operation. 网络连接实例正在处理状态,请稍后再操作。

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