文档

CreateTransitRouterVpnAttachment - 创建VPN连接

更新时间:

转发路由器支持连接VPN网关的IPsec连接。本地数据中心可以通过IPsec连接直接连接至转发路由器,然后通过转发路由器实现与其他网络的互通,调用CreateTransitRouterVpnAttachment接口创建VPN连接。

接口说明

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

前提条件

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

调试

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

授权信息

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

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

请求参数

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

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

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

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
123e4567-e89b-12d3-a456-42665544****
DryRunboolean

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

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

云企业网实例 ID。

cen-rsgxs8ng2awen2****
TransitRouterIdstring

转发路由器实例 ID。

tr-p0wm740vjnbaprv0m****
RegionIdstring

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

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

ap-southeast-2
TransitRouterAttachmentNamestring

VPN 连接的名称。

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

nametest
TransitRouterAttachmentDescriptionstring

VPN 连接的描述信息。

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

desctest
VpnIdstring

IPsec 连接 ID。

vco-p0w042cqwvlhl4zyw****
VpnOwnerIdlong

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

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

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

  • true(默认值):允许。
  • false:不允许。
true
ChargeTypestring

计费方式。

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

POSTPAY
Zoneobject []

当前地域下的可用区 ID。

系统将在您指定的可用区下创建资源。

ZoneIdstring

可用区 ID。

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

ap-southeast-2a
Tagobject []

标签信息列表。

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

Keystring

资源的标签键。

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

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

TagKey
Valuestring

资源的标签值。

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

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

TagValue

返回参数

名称类型描述示例值
object

返回结果。

TransitRouterAttachmentIdstring

VPN 连接 ID。

tr-attach-y5dup2qwfyh9lu****
RequestIdstring

请求 ID。

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

示例

正常返回示例

JSON格式

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

错误码

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.转发路由器服务未打开,请打开后重试。
400InvalidTransitRouterMode.NeedUpgradeTransitRouter need to upgrade.当前转发路由器模式不支持。
400InvalidAvailable.NoResourceNo resource in the available zone.当前可用区资源不足。
400OperationUnsupported.VpnAttachmentThe specified region does not support the operation.当前地域不支持该操作。
400OperationUnsupported.TransitRouterTypeThe specified TransitRouterType does not support the operation.当前TransitRouter类型不支持该操作。
400OperationFailed.AllocateCidrFailedOperation failed because vpn allocate cidr failed.vpn申请cidr失败。
400OperationUnsupported.ZoneIdThe specified ZoneId does not support the operation.-
400MissingParam.CenIdOrRegionIdEither CenId or RegionId must be specified.CenId或者RegionId是必选参数。
400IllegalParam.RegionIdRegionId is illegal.参数中指定的Region不合法。
400OperationUnsupported.CenFullLevelCEN full level does not support TransitRouterFull类型CEN不支持创建企业版转发路由器。
400InvalidOperation.CenInstanceStatusThe CEN instance is not in a valid state for the operation. -
400IllegalParam.ZoneMappingsThe Specified Parameter ZoneMappings is illegal参数中指定的ZoneMappings不合法。
400IncorrectStatus.TransitRouterThe status of TransitRouter is incorrect.当前TransitRouter的状态不支持该操作,请稍后重试。
400InvalidOperation.VpnNetworkTypeInvalidThe network type of child-instance is invalid.该实例的network type不合法。
400QuotaExceeded.CenQuotaVpnAttachPerTransitRouterThe maximum number of VPN attachment per Transit Router is exceeded.每个转发路由器支持创建的VPN连接个数超限,可提交工单提升额度。
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.账号无权限操作。

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

变更历史

变更时间变更内容概要操作
2023-01-04OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
2022-12-22OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
  • 本页导读 (1)
文档反馈