调用CreateTransitRouterVpnAttachment接口创建VPN连接。

使用说明

  • 当前仅部分地域的企业版转发路由器支持创建VPN连接。如需使用,请向客户经理申请或提交工单申请。关于地域的信息,请参见创建VPN连接

  • 创建VPN连接后,VPN连接默认不与任何转发路由器路由表建立路由学习关系和关联转发关系。
  • 在调用CreateTransitRouterVpnAttachment接口的过程中,如果您指定了CenIdRegionId参数的值,则无需指定TransitRouterId参数的值;如果您指定了TransitRouterIdRegionId参数的值,则无需指定CenId参数的值。

前提条件

  • 在创建VPN连接前,请确保您已经在转发路由器实例所在的地域创建了一个IPsec连接,且IPsec连接未绑定任何资源。具体操作,请参见CreateVpnAttachment
  • 如果转发路由器实例需要连接跨账号的IPsec连接,则需确保IPsec连接已对转发路由器实例授权。具体操作,请参见GrantInstanceToTransitRouter

调试

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

请求参数

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

系统规定参数。取值:CreateTransitRouterVpnAttachment

ClientToken String 123e4567-e89b-12d3-a456-42665544****

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

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

说明 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
DryRun Boolean false

是否只预检此次请求。取值:

  • true:发送检查请求,不会创建VPN连接。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后直接创建VPN连接。
CenId String cen-rsgxs8ng2awen2****

云企业网实例ID。

TransitRouterId String tr-p0wm740vjnbaprv0m****

转发路由器实例ID。

RegionId String ap-southeast-2

转发路由器实例所属的地域ID。

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

TransitRouterAttachmentName String nametest

VPN连接的名称。

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

TransitRouterAttachmentDescription String desctest

VPN连接的描述信息。

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

VpnId String vco-p0w042cqwvlhl4zyw****

IPsec连接ID。

VpnOwnerId Long 1210123456123456

IPsec连接所属的阿里云账号(主账号)ID。

  • 如果不输入本参数,默认使用当前登录的阿里云账号ID。
  • 如果您要连接跨账号的IPsec连接时,本参数必填。
AutoPublishRouteEnabled Boolean true

是否允许转发路由器实例自动向IPsec连接发布路由条目。取值:

  • true(默认值):允许。
  • false:不允许。
ChargeType String POSTPAY

计费方式。

仅取值:POSTPAY(默认值),表示按使用量付费。

Zone.N.ZoneId String ap-southeast-2a

可用区ID。

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

Tag.N.Key String TagKey

资源的标签键。

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

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

Tag.N.Value String TagValue

资源的标签值。

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

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

返回数据

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

VPN连接ID。

RequestId String 8B5DD40A-3A29-5AC0-B8DA-05FD10D5C893

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateTransitRouterVpnAttachment
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&DryRun=false
&CenId=cen-rsgxs8ng2awen2****
&TransitRouterId=tr-p0wm740vjnbaprv0m****
&RegionId=ap-southeast-2
&TransitRouterAttachmentName=nametest
&TransitRouterAttachmentDescription=desctest
&VpnId=vco-p0w042cqwvlhl4zyw****
&VpnOwnerId=1210123456123456
&AutoPublishRouteEnabled=true
&ChargeType=POSTPAY
&Zone=[{"ZoneId":"ap-southeast-2a"}]
&公共请求参数

正常返回示例

XML格式

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

<CreateTransitRouterVpnAttachmentResponse>
    <TransitRouterAttachmentId>tr-attach-y5dup2qwfyh9lu****</TransitRouterAttachmentId>
    <RequestId>8B5DD40A-3A29-5AC0-B8DA-05FD10D5C893</RequestId>
</CreateTransitRouterVpnAttachmentResponse>

JSON格式

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

{
  "TransitRouterAttachmentId" : "tr-attach-y5dup2qwfyh9lu****",
  "RequestId" : "8B5DD40A-3A29-5AC0-B8DA-05FD10D5C893"
}

错误码

HttpCode 错误码 错误信息 描述
400 NoPermission.AliyunServiceRolePolicyForCEN You 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权限。
400 OperationUnsupported.TransitRouterRegionId The specified TransitRouterRegion does not support the operation. 中转地域不支持此操作。
400 InvalidCenId.NotFound CenId is not found. CEN实例不存在。
400 InvalidTransitRouterId.NotFound TransitRouterId is not found. 转发路由实例ID不存在。
400 Forbbiden.TransitRouterServiceNotOpen The user has not open transit router service. 转发路由器服务未开通,请开通后再使用。
400 OperationUnsupported.TransitRouterType The specified TransitRouterType does not support the operation. 该类型转发路由器不支持此操作
400 OperationFailed.AllocateCidrFailed Operation failed because vpn allocate cidr failed. vpn分配cidr失败导致无法执行该操作。

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