调用CreateTransitRouterPeerAttachment接口为企业版转发路由器实例创建跨地域连接。
背景信息
在您创建跨地域连接前,您需要先购买带宽包。具体操作,请参见CreateCenBandwidthPackage。
使用说明
CreateTransitRouterPeerAttachment接口属于异步接口,即系统会先返回一个跨地域连接ID,但该跨地域连接并未创建完成,系统后台的创建任务仍在进行。您可以调用ListTransitRouterPeerAttachments接口查询跨地域连接的状态。
- 当跨地域连接处于Attaching状态时,表示跨地域连接正在创建中,在该状态下,您只能对跨地域连接执行查询操作,不能执行其他操作。
- 当跨地域连接处于Attached状态时,表示跨地域连接创建完成。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | CreateTransitRouterPeerAttachment |
系统规定参数。取值:CreateTransitRouterPeerAttachment。 |
| ClientToken | String | 否 | 02fb3da4-130e-11e9-8e44-001**** |
客户端Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。 说明 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
|
| 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个字符,必须以字母或中文开头,但不能以 |
| PeerTransitRouterId | String | 是 | tr-m5eq27g6bndum7e88**** |
对端转发路由器实例ID。 |
| PeerTransitRouterRegionId | String | 否 | cn-qingdao |
对端转发路由器实例所属地域ID。 |
| AutoPublishRouteEnabled | Boolean | 否 | false |
是否使企业版转发路由器自动发布跨地域连接的路由到对端地域。
|
| Bandwidth | Integer | 否 | 2 |
跨地域连接的带宽值。单位:Mbps。 |
| CenBandwidthPackageId | String | 否 | cenbwp-3xrxupouolw5ou**** |
跨地域连接要绑定的带宽包ID。 如果您不输入带宽包ID,则表示您要使用测试带宽。测试带宽默认为1 Kbps,仅供您测试跨地域(IPv4)网络的联通性。 |
| DryRun | Boolean | 否 | false |
是否对此次请求执行预检,包括权限、实例状态校验等。取值:
|
| BandwidthType | String | 否 | BandwidthPackage |
跨地域连接的带宽分配方式。取值: BandwidthPackage:从带宽包中分配带宽。 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| TransitRouterAttachmentId | String | tr-attach-nwkiqfvw22qesz**** |
跨地域连接ID。 |
| RequestId | String | 59422BF5-BAAD-4CFD-9019-9557BD3ACFA3 |
请求ID。 |
示例
请求示例
http(s)://[Endpoint]/?Action=CreateTransitRouterPeerAttachment
&ClientToken=02fb3da4-130e-11e9-8e44-001****
&CenId=cen-j3jzhw1zpau2km****
&TransitRouterId=tr-bp1su1ytdxtataupl****
&RegionId=cn-hangzhou
&TransitRouterAttachmentName=testname
&TransitRouterAttachmentDescription=testdesc
&PeerTransitRouterId=tr-m5eq27g6bndum7e88****
&PeerTransitRouterRegionId=cn-qingdao
&AutoPublishRouteEnabled=false
&Bandwidth=2
&CenBandwidthPackageId=cenbwp-3xrxupouolw5ou****
&DryRun=false
&BandwidthType=BandwidthPackage
&公共请求参数
正常返回示例
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. | 带宽值参数是必需的。 |
访问错误中心查看更多错误码。