You need to enable JavaScript to run this app.
导航
中转路由器
  • 文档首页
    • /中转路由器/API参考/跨地域连接/CreateTransitRouterPeerAttachment
CreateTransitRouterPeerAttachment
最近更新时间：2024.09.09 11:40:38首次发布时间：2023.09.12 10:21:32
我的收藏

调用 CreateTransitRouterPeerAttachment 接口，创建一个跨地域连接。

调试

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

请求参数

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

名称类型是否必选示例值描述
ActionString是CreateTransitRouterPeerAttachment要执行的操作，取值为CreateTransitRouterPeerAttachment。
VersionString是2020-04-01API版本信息，当前版本为2020-04-01。
TransitRouterIdString是tr-7qthudw0ll6jmc****本端中转路由器实例的ID。

TransitRouterAttachmentName

String

否

tr-attachment

跨地域连接的名称。

  • 必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：点号（.）、下划线（_）和短横线（-）。
  • 长度限制为1 ~ 128个字符。
  • 不传入该参数或该参数不传入数值时，默认为中转路由器实例的ID。

Description

String

否

This peer attachment is used for test.

跨地域连接的描述信息。

  • 必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。
  • 长度限制为0 ~ 255个字符。
  • 不传入该参数或该参数不传入数值时，默认为空字符串。
PeerTransitRouterIdString是tr-q3wuhuumlho9r****对端中转路由器实例的ID。您可以调用DescribeTransitRouters接口获取中转路由器实例的ID。
PeerTransitRouterRegionIdString是cn-beijing对端中转路由器实例所属地域的ID。您可以参考地域介绍获取地域ID。

TransitRouterBandwidthPackageId

String

否

tr-bp-qw2u6ur8lhe2t****

中转路由器带宽包的ID。您可以调用DescribeTransitRouterBandwidthPackages接口获取中转路由器带宽包的ID。
传入该参数时必须传入参数Bandwidth，未传入该参数时无需传入参数Bandwidth。

Bandwidth

Integer

否

2

跨地域连接的带宽，单位为Mbps。
带宽最大值不能超过指定中转路由器带宽包剩余未分配的带宽上限。

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-12w7hruhlhlrd****跨地域连接的ID。

请求示例

GET /?Action=CreateTransitRouterPeerAttachment&Version=2020-04-01&TransitRouterId=tr-7qthudw0ll6jmc****&PeerTransitRouterId=tr-q3wuhuumlho9r****&PeerTransitRouterRegionId=cn-beijing HTTP/1.1
Host: open.volcengineapi.com
Service: transitrouter
Region: cn-guangzhou

返回示例

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

错误码

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

HttpCode错误码错误信息描述
400IdempotentParameterMismatchArguments on this idempotent request are inconsistent with arguments used in previous request(s).此幂等请求的参数与前一个请求中使用的参数不一致。
400InvalidDescription.MalformedThe specified description is malformed. Ensure the maximum length of description is 255.指定的描述格式不合法。描述长度不能超过255个字符。
400InvalidDescription.MalformedThe specified description is malformed.指定的描述格式不合法。请修复描述格式后重试。
400InvalidLocalRegionId.ConflictThe specified LocalRegionId and PeerRegionId are the same.指定的本端地域和对端地域相同。
400InvalidName.MalformedThe specified name is malformed.指定的名称格式不合法。请修复名称格式后重试。
400InvalidName.MalformedThe specified name is malformed. Ensure the maximum length of name is 128.指定的名称格式不合法。名称长度不能超过128个字符。
400InvalidParameter.ClientTokenMalformedThe specified parameter ClientToken is malformed.指定的参数ClientToken格式不合法，长度不能超过64个ASCII字符。
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.指定的中转路由器所处状态无法响应该请求。
400InvalidTransitRouterPeerAttachment.PeerRegionNotSupportedThe specified peer region does not support to create peer attachment.指定的对端地域不支持创建跨地域连接。
400InvalidTransitRouterRouteTableAssociation.TransitRouterMismatchThe specified route table and attachment do not belong to one same Transit Router.指定的路由表所属的中转路由器和网络实例连接挂载的中转路由器不一致。
400LimitExceeded.InterRegionBandwidthThe specified peer attachment bandwidth exceeds the lower limit.指定的带宽大小超出域间带宽最小限制。
400LimitExceeded.InterRegionBandwidthThe specified inter region bandwidth exceeds the available bandwidth of the bandwidth package.指定的域间带宽大小超出带宽包可分配的带宽。
400LimitExceeded.ResourceIdsYou've reached the limit of 100 resource IDs that can be specified in this request.该请求传入了非法或不支持的参数。资源查询数目最大限制100。
400QuotaExceeded.InterRegionPeerAttachmentYou've reached the maximum number of inter region attachments that one transit router can have.已达到单个中转路由器可创建的跨地域网络实例连接的上限。
400QuotaExceeded.TransitRouterAttachmentYou've reached the maximum number of attachments that one Transit Router can have.已达到单个中转路由器可创建的网络实例上限。
400UnsupportedOperation.ExpiredStatusThe request on the specified bandwidth package is denied because the bandwidth package is expired.指定带宽包已过期，不支持当前操作。
400MissingParameterThe specified peer attachment with a bandwidth package assigned to it, needs to allocate an inter region bandwidth parameter.跨地域连接指定了带宽包，请分配跨域带宽。
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.已达到单次可操作标签数量的上限。
400InvalidTransitRouterPeerAttachment.PeerRegionIdConfictThe peer region id of the specified attachment conflicts with current region.指定网络实例连接的对端区域必须和当前区域不同。
400InvalidTransitRouterPeerAttachment.PeerTransitRouterInvalidStatusThe specified peer Transit Router is not in the correct status for the request.指定的对端中转路由器所处状态无法响应该请求。
400InvalidInterRegionBandwidth.ExistedThe specified inter region bandwidth existed.指定的跨域带宽已经存在。
400InvalidTransitRouterBandwidthPackage.InvalidStatusThe specified TransitRouter bandwidth package is being operated now.指定的带宽包所处状态无法响应该请求，请稍后重试。
400InvalidRegionId.ConflictThe LocalRegionId or PeerRegionId of peer attachment are different from bandwidth package.指定的带宽包和跨地域连接的互通地域不一致。
400InvalidTransitRouterPeerAttachment.SharedTransitRouterThe specified peer Transit Router is shared instance, and does not support to create peer attachment.指定的对端中转路由器是共享实例，不支持创建跨地域连接。
403Forbidden.CreateTransitRouterPeerAttachmentYou are not authorized to create peer attachment on Transit Router.无权限创建跨域网络实例连接，请开通跨域网络实例连接的白名单。
403Forbidden.EnablePeerTransitRouterRouteTablePropagationYou are not authorized to enable peer attachment route table propagation.无权限开启跨地域连接的路由学习功能，请开通白名单。
404InvalidRegionId.NotFoundThe specified RegionId does not exist.指定的地域不存在。
404InvalidTransitRouter.NotFoundThe specified Transit Router does not exist.指定的中转路由器不存在。
404InvalidPeerTransitRouter.NotFoundThe specified peer Transit Router does not exist.指定的对端中转路由器不存在。
404InvalidTransitRouterBandwidthPackage.NotFoundThe specified bandwidth package id does not exist.指定的带宽包不存在。
404InvalidTransitRouterRouteTable.NotFoundThe specified route table does not exist.指定的中转路由器路由表不存在。
404InvalidPeerTransitRouterRouteTable.NotFoundThe specified route table of peer Transit Router does not exist.指定的对端中转路由器路由表不存在。
409InvalidParameter.ParameterConflictCannot set the bandwidth when peer attachment has not associated bandwidth package.跨地域连接未加入带宽包，不支持设置跨地域带宽。
412IdempotentProcessingThe request uses the same client token as a previous one that is still in process.幂等请求处理中。