You need to enable JavaScript to run this app.
导航
中转路由器
  • 文档首页
    • /中转路由器/API参考/VPN类型网络实例连接/CreateTransitRouterVpnAttachment
CreateTransitRouterVpnAttachment
最近更新时间：2024.10.11 14:15:38首次发布时间：2023.03.07 09:56:38
我的收藏

调用CreateTransitRouterVpnAttachment接口，创建一个VPN类型的网络实例连接。

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

下表中，Tags.N.a类型参数中的“N”表示标签信息的序号，需按照数字顺序从1开始填写，取值范围为1～50。多个标签之间使用&分隔。每个标签键对应一个标签值。

名称类型是否必选示例值描述
ActionString是CreateTransitRouterVpnAttachment要执行的操作，取值为CreateTransitRouterVpnAttachment。
VersionString是2020-04-01API版本信息，当前版本为2020-04-01。
TransitRouterIdString是tr-7qthudw0ll6jmc****中转路由器实例的ID。您可以调用DescribeTransitRouters接口获取中转路由器实例ID。
VpnConnectionIdString是vgc-3tex2x1cwd4c6c0v****IPsec连接的ID。您可以调用DescribeVpnConnections接口获取IPsec连接的ID。
ZoneIdString是cn-guangzhou-aIPsec连接所属可用区的ID。

Description

String

否

This attachment is used for test.

网络实例连接的描述信息。

  • 必须以字母、数字或中文开头，可包含字母、数字、中文及以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。
  • 长度限制为0 ~ 255个字符。
  • 不传入该参数或该参数不传入数值时，默认为空字符串。

TransitRouterAttachmentName

String

否

attachment-vpn

网络实例连接的名称。

  • 必须以字母、数字或中文开头，可包含字母、数字、中文及以下特殊字符：点号（.）、下划线（_）和短横线（-）。
  • 长度限制为1 ~ 128个字符。
  • 不传入该参数或该参数不传入数值时，默认为网络实例连接的ID。
TransitRouterRouteTableIdString否rtb-2wuguyklhi6t****关联转发的TR路由表ID。您可以调用DescribeTransitRouterRouteTables接口获取TR路由表的ID。

ClientToken

String

否

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

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

  • 该参数值由客户端自动生成，确保不同请求的取值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。
  • 取值仅支持ASCII字符，最大不超过64个字符。
  • 未指定该参数值时，不进行幂等校验。

Tags.N.Key

String

否

Tags.1.Key=k1&Tags.2.Key=k2

网络实例连接用户标签的标签键。

  • 长度限制为1～128个字符。
  • 大小写敏感，不能以volc:的任意大小写组合开头。
  • 不能以空格开头或结尾。
  • 允许包含字母、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。

说明

  • 同一资源的标签键不允许重复。
  • 不传入该参数或该参数不传入数值时，默认为空。

Tags.N.Value

String

否

Tags.1.Value=v1&Tags.2.Value=v2

网络实例连接用户标签的标签值。

  • 长度限制为0～255个字符。
  • 大小写敏感，不能以空格开头或结尾。
  • 允许包含字母、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。

说明

如果传入该参数，则必须先传入Tags.N.Key。

返回参数

名称
类型
示例值
描述
TransitRouterAttachmentIdStringtr-attach-1ffn6gjk****网络实例连接的ID。

请求示例

GET /?Action=CreateTransitRouterVpnAttachment&Version=2020-04-01&TransitRouterId=tr-7qthudw0ll6jmc****&VpnConnectionId=vgc-3tex2x1cwd4c6c0v****&ZoneId=cn-guangzhou-a HTTP/1.1
Host: open.volcengineapi.com
Service: transitrouter
Region: cn-guangzhou

返回示例

{
    "ResponseMetadata": {
        "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",
        "Action": "CreateTransitRouterVpnAttachment",
        "Version": "2020-04-01",
        "Service": "transitrouter",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "TransitRouterAttachmentId": "tr-attach-1ffn6gjk****"
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HttpCode错误码错误信息描述
400InvalidDescription.MalformedThe specified description is malformed. Ensure the maximum length of description is 255.指定的描述格式不合法。描述长度不能超过255个字符。
400InvalidDescription.MalformedThe specified description is malformed.指定的描述格式不合法。请修复描述格式后重试。
400InvalidName.MalformedThe specified name is malformed. Ensure the maximum length of name is 128.指定的名称格式不合法。名称长度不能超过128个字符。
400InvalidName.MalformedThe specified name is malformed.指定的名称格式不合法。请修复名称格式后重试。
400InvalidTransitRouter.InvalidBusinessStatusThe request is denied because the specified Transit Router is shut down due to arrears.指定的中转路由器欠费关停，不支持当前操作。
400InvalidTransitRouter.InvalidStatusThe specified Transit Router is not in the correct status for the request.指定的中转路由器所处状态无法响应该请求。
400InvalidTransitRouterAttachment.InvalidVpnConnectionBusinessStatusThe request is denied because the specified IPSec Connection is shut down due to arrears.指定的IPSec连接欠费关停，不支持当前操作。
400InvalidTransitRouterAttachment.InvalidVpnConnectionStatusThe operation is not supported by the current status of the specified IPSec connection.当前IPSec连接状态不支持此操作，请稍后重试。
400InvalidTransitRouterAttachment.VpnConnectionAttachTypeMalformedThe specified IPSec connection AttachType is malformed.指定IPSec连接的绑定资源类型不合法。
400InvalidTransitRouterAttachment.ZoneUnsupportedThere are available zones not supported by Transit Router.指定的部分可用区暂不支持创建网络实例连接。
400QuotaExceeded.TransitRouterAttachmentYou've reached the maximum number of attachments that one Transit Router can have.已达到单个中转路由器可创建的网络实例上限。
400InvalidTransitRouterAttachment.InsufficientResourceThe specified region does not have enough resources for Transit Router attachment.网络实例连接可用资源不足。
400OrderErrorFailed to create order and pay in one step.创建订单并支付失败。
400UnsupportedOperationThe request on the specified instance is denied due to the account balance and available vouchers are less than 100 yuan in total.因账户余额及可用代金券共不足100元，对于该实例的操作请求被拒绝。
400UnsupportedOperationThe request on the specified instance is denied due to the account in arrears status.因账户处于欠费状态，对于该实例的操作请求被拒绝。
400QuotaExceeded.VpnAttachmentYou've reached the maximum number of vpn attachments that one transit router can have.已达到单个中转路由器可创建的vpn网络实例连接的上限。
400IdempotentParameterMismatchArguments on this idempotent request are inconsistent with arguments used in previous request(s).此幂等请求的参数与前一个请求中使用的参数不一致。
400InvalidParameter.ClientTokenMalformedThe specified parameter ClientToken is malformed.指定的参数ClientToken格式不合法，长度不能超过64个ASCII字符。
400InvalidTag.DisorderThe specified index order of tag is malformed.指定标签的索引顺序参数格式不合法。
400InvalidTagKey.MalformedThe specified parameter tag key is invalid.标签键不合法。
400InvalidTagValue.MalformedThe specified parameter tag value is invalid.标签值不合法。
400LimitExceeded.TagsYou've reached the limit on the number of tags that you can operate at a time.已达到单次可操作标签数量的上限。
400InvalidTransitRouterAttachment.TransitRouterLackOfAsnThe specified Transit Router is lack of ASN, and cannot create BGP vpn attachment on it.指定的中转路由器没有配置ASN，无法创建BGP路由类型的VPN网络实例连接。
400InvalidTransitRouterRoutePropagation.TransitRouterMismatchThe specified route table and attachment do not belong to one same Transit Router.指定的路由表所属的中转路由器和网络实例连接挂载的中转路由器不一致。
403Forbidden.CreateTransitRouterBgpVpnAttachmentYou are not authorized to create BGP vpn attachment on Transit Router.无权限创建BGP类型的VPN网络实例连接，请在中转路由器产品开通对应的白名单。
403Forbidden.NoPermissionToOperateYou are not authorized to operate the specified resource.无权限操作指定的资源。
403Forbidden.CreateTransitRouterVpnAttachmentYou are not authorized to create vpn attachment on Transit Router.无权限创建VPN网络实例连接，请开通VPN网络实例连接的白名单。
403Forbidden.VpnConnectionBlockedThe specified IPSec is blocked.指定的IPSec封禁中，禁止操作。
403Forbidden.PurchaseLimitedThe account is not authorized to purchase the resource.此账户无权限购买资源。
404InvalidTransitRouterRouteTable.NotFoundThe specified route table does not exist.指定的中转路由器路由表不存在。
404InvalidTransitRouter.NotFoundThe specified Transit Router does not exist.指定的中转路由器不存在。
404InvalidTransitRouterAttachment.VpnConnectionNotFoundThe specified IPSec connection does not exist.指定的IPSec连接不存在。
409InvalidTransitRouterAttachment.ConflictThe specified instance has already been attached to the Transit Router.指定的网络实例已加入指定的中转路由器，不支持重复操作。
409InvalidTransitRouterAttachment.IPSecConnectionAsnConflictThe specified IPSec connection ASN conflicts with Transit Router ASN.指定的IPSec连接ASN和中转路由器的ASN冲突，请配置不同的ASN号。
409InvalidTransitRouterAttachment.IPSecConnectionBgpTunnelCidrConflictThe specified IPSec connection BGP tunnel cidr conflicts with the service cidr of the Transit Router.指定的IPSec连接的BGP隧道地址和中转路由器的服务网段冲突，请配置不同的BGP隧道地址。
412IdempotentProcessingThe request uses the same client token as a previous one that is still in process.幂等请求处理中。