调用CreateTransitRouterPeerAttachment接口为企业版转发路由器实例创建跨地域连接。

使用说明

转发路由器之间默认有1 Kbps跨地域互通带宽,仅供您测试跨地域(IPv4)网络的连通性。如果您需要实现跨地域间的业务互通,您需要创建跨地域连接,并为跨地域连接分配带宽。

企业版转发路由器支持以下两种带宽分配方式:

  • 从带宽包分配

    使用此种分配方式,您需要先购买带宽包,从带宽包中为跨地域连接分配带宽。购买带宽包具体操作,请参见CreateCenBandwidthPackage

  • 按流量付费

    使用此种分配方式,您需要为跨地域连接设置限速带宽,系统会按照跨地域连接实际使用的流量计费。具体计费信息,请参见跨地域流量

调试

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

请求参数

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

系统规定参数。取值:CreateTransitRouterPeerAttachment

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

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

由客户端生成该参数值,该参数需保证在不同请求间唯一,最大值不超过64个ASCII字符。

CenId String cen-j3jzhw1zpau2km****

云企业网实例ID。

TransitRouterId String tr-bp1su1ytdxtataupl****

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

RegionId String cn-hangzhou

本端企业版转发路由器实例所属地域ID。

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

TransitRouterAttachmentName String testname

跨地域连接的名称。

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

TransitRouterAttachmentDescription String testdesc

跨地域连接的描述信息。

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

PeerTransitRouterId String tr-m5eq27g6bndum7e88****

对端转发路由器实例ID。

PeerTransitRouterRegionId String cn-qingdao

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

AutoPublishRouteEnabled Boolean false

是否使企业版转发路由器自动发布跨地域连接的路由到对端地域。

  • false(默认值):否。
  • true:是。
Bandwidth Integer 2

跨地域连接的带宽值。单位:Mbps。

  • BandwidthType取值为BandwidthPackage时,该参数表示跨地域连接可使用的带宽值。
  • BandwidthType取值为DataTransfer时,该参数表示跨地域连接的限速带宽值。
CenBandwidthPackageId String cenbwp-3xrxupouolw5ou****

跨地域连接要绑定的带宽包ID。

说明BandwidthType取值为DataTransfer时,无需配置该项。
DryRun Boolean false

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

  • false(默认值):发送正常请求,通过检查后直接创建跨地域连接。
  • true:发送检查请求,只进行校验,不会创建跨地域连接。检查项包括是否填写了必需参数、请求格式等。如果检查不通过,则返回对应错误。如果检查通过,则返回对应请求ID。
BandwidthType String BandwidthPackage

跨地域连接的带宽分配方式。取值:

BandwidthPackage:从带宽包中分配带宽。

DataTransfer:不为跨地域连接分配带宽,按使用流量计费。

返回数据

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

跨地域连接ID。

RequestId String 59422BF5-BAAD-4CFD-9019-9557BD3ACFA3

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateTransitRouterPeerAttachment
&PeerTransitRouterId=tr-m5eq27g6bndum7e88****
&<公共请求参数>

正常返回示例

XML格式

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

<CreateTransitRouterPeerAttachmentResponse> 
<TransitRouterAttachmentId>tr-attach-nwkiqfvw22qesz****</TransitRouterAttachmentId>
<RequestId>59422BF5-BAAD-4CFD-9019-9557BD3ACFA3</RequestId>
</CreateTransitRouterPeerAttachmentResponse>

JSON格式

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

{
  "TransitRouterAttachmentId" : "tr-attach-nwkiqfvw22qesz****",
  "RequestId" : "59422BF5-BAAD-4CFD-9019-9557BD3ACFA3"
}

错误码

HttpCode 错误码 错误信息 描述
400 OperationUnsupported.TransitRouterRegionId The specified TransitRouterRegion does not support the operation. 中转地域不支持此操作。
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 InvalidTransitRouterId.NotFound TransitRouterId is not found. 转发路由实例ID不存在。
400 IllegalParam.PeerTransitRouterId PeerTransitRouterId is illegal. 跨地域连接时,对端的转发路由器ID非法。
400 OperationUnsupported.TransitRouterId TransitRouterId is unsupported. 转发路由器类型是基础版时不支持。
400 MissingParam.Bandwidth The parameter Bandwidth is mandatory. 带宽值参数是必需的。
400 IllegalParam.Bandwidth Bandwidth is illegal 跨地域连接时入参带宽值非法。

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