全部产品
Search
文档中心

云企业网:CreateTransitRouterPeerAttachment - 为企业版转发路由器实例创建跨地域连接

更新时间:Feb 07, 2023

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

接口说明

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

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

  • 从带宽包分配

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

  • 按流量付费

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

CreateTransitRouterPeerAttachment接口属于异步接口,即系统会先返回一个跨地域连接ID,但该跨地域连接并未创建完成,系统后台的创建任务仍在进行。您可以调用ListTransitRouterPeerAttachments接口查询跨地域连接的状态。

  • 当跨地域连接处于Attaching状态时,表示跨地域连接正在创建中,在该状态下,您只能对跨地域连接执行查询操作,不能执行其他操作。
  • 当跨地域连接处于Attached状态时,表示跨地域连接创建完成。

调试

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

调试

授权信息

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

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

请求参数

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

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

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

说明若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
02fb3da4-130e-11e9-8e44-001****
CenIdstring

云企业网实例ID。

cen-j3jzhw1zpau2km****
TransitRouterIdstring

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

tr-bp1su1ytdxtataupl****
RegionIdstring

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

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

cn-hangzhou
TransitRouterAttachmentNamestring

跨地域连接的名称。

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

testname
TransitRouterAttachmentDescriptionstring

跨地域连接的描述信息。

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

testdesc
PeerTransitRouterIdstring

对端转发路由器实例ID。

tr-m5eq27g6bndum7e88****
PeerTransitRouterRegionIdstring

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

cn-qingdao
AutoPublishRouteEnabledboolean

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

  • false(默认值):否。
  • true:是。
false
Bandwidthinteger

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

  • BandwidthType取值为BandwidthPackage时,该参数表示跨地域连接可使用的带宽值。

  • BandwidthType取值为DataTransfer时,该参数表示跨地域连接的限速带宽值。

2
CenBandwidthPackageIdstring

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

说明BandwidthType取值为DataTransfer时,无需配置该项。
cenbwp-3xrxupouolw5ou****
DryRunboolean

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

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

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

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

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

BandwidthPackage
Tagarray

标签信息。

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

object
Keystring

资源的标签键。

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

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

tag_A1
Valuestring

资源的标签值。

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

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

value_A1

返回参数

名称类型描述示例值
object

返回结果。

TransitRouterAttachmentIdstring

跨地域连接ID。

tr-attach-nwkiqfvw22qesz****
RequestIdstring

请求ID。

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

示例

正常返回示例

JSON格式

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

错误码

Http code错误码错误信息描述
400OperationUnsupported.TransitRouterRegionIdThe specified TransitRouterRegion does not support the operation.中转地域不支持此操作。
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权限。
400InvalidTransitRouterId.NotFoundTransitRouterId is not found.转发路由实例ID不存在。
400IllegalParam.PeerTransitRouterIdPeerTransitRouterId is illegal.跨地域连接时,对端的转发路由器ID非法。
400OperationUnsupported.TransitRouterIdTransitRouterId is unsupported.转发路由器类型是基础版时不支持。
400MissingParam.BandwidthThe parameter Bandwidth is mandatory.带宽值参数是必需的。
400IllegalParam.BandwidthBandwidth is illegal.带宽包id不合法。
400Forbbiden.TransitRouterServiceNotOpenThe user has not open transit router service.转发路由器服务未打开,请打开后重试。
400OperationUnsupported.TransitRouterTypeThe specified TransitRouterType does not support the operation.当前TransitRouter类型不支持该操作。
400OperationUnsupported.BandwidthTypeThe specified BandwidthType does not support the operation.当前BandwidthType不支持该操作。
400InvalidCenId.NotFoundCenId is not found.CEN实例不存在。
400IllegalParam.BandwidthTypeBandwidthType is illegal.带宽包类型不合法。
400MissingParam.CenIdOrRegionIdEither CenId or RegionId must be specified.CenId或者RegionId是必选参数。
400OperationUnsupported.BandwidthHSThis bandwidth limit can only be set in China-AsiaPacific-HS-
400OperationUnsupported.CenFullLevelCEN full level does not support TransitRouterFull类型CEN不支持创建企业版转发路由器。
400OperationUnsupported.CloudDataTransferServiceCCN region not support cloud data transfer service.CCN地域中不支持cloud data transfer服务。
400InvalidPeerTransitRouterId.NotFoundThe specified PeerTransitRouterId is not found.参数中指定的PeerTransitRouterId不存在。
400IllegalParam.RegionIdRegionId is illegal.参数中指定的Region不合法。
400IllegalParam.PeerRegionIdPeerRegionId is illegal.参数中指定的PeerRegionId不合法。
400IllegalParam.TransitRouterRegionIdTransitRouterRegionId is illegal.TransitRouterRegionId不合法。
400InvalidOperation.CenInstanceStatusThe CEN instance is not in a valid state for the operation. -
400IncorrectStatus.TransitRouterThe status of TransitRouter is incorrect.当前TransitRouter的状态不支持该操作,请稍后重试。
400InvalidOperation.BwpNotAssociatedOperation is invalid because a bandwidth package corresponding to the geographic span is not associated.与地域对应的带宽包未关联,无法操作。
400InvalidOperation.BwpBusinessStatusThe CBN bandwidth package is not in a valid business state for the operation.带宽包不处于稳态,无法操作。
400IllegalParam.CenBandwidthPackageIdParameter CenBandwidthPackageId is illegal.参数中指定的CenBandwidthPackageId不合法。
400InvalidOperation.BwpBandwidthExceededOperation is invalid because the total bandwidth limit has exceeded that of the bandwidth package.设置带宽值已超出带宽包带宽

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

变更历史

变更时间变更内容概要操作
2023-01-04OpenAPI 错误码发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
2022-12-22OpenAPI 错误码发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更