调用CreateTransitRouterVbrAttachment接口在企业版转发路由器下创建边界路由器VBR(Virtual border router)连接。
使用说明
- 企业版转发路由器支持的地域和可用区信息,请参见什么是云企业网。
- 您可以通过以下两种方式在企业版转发路由器下创建VBR连接:
- 如果您已经在目标地域创建了企业版转发路由器实例,您可以通过指定VbrId和TransitRouterId创建VBR连接。
- 如果您在目标地域没有企业版转发路由器实例,您可以通过指定VbrId、CenId和RegionId创建VBR连接。创建VBR连接时系统为您自动创建企业版转发路由器实例。
- CreateTransitRouterVbrAttachment接口属于异步接口,即系统会先返回一个VBR连接ID,但该VBR连接并未创建完成,系统后台的创建任务仍在进行。您可以调用ListTransitRouterVbrAttachments接口查询VBR连接的状态。
- 当VBR连接处于Attaching状态时,表示VBR连接正在创建中,在该状态下,您只能对VBR连接执行查询操作,不能执行其他操作。
- 当VBR连接处于Attached状态时,表示VBR连接创建完成。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | CreateTransitRouterVbrAttachment |
系统规定参数。取值:CreateTransitRouterVbrAttachment。 |
| 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 |
VBR实例所属地域ID。 您可以通过调用DescribeRegions接口获取地域ID。 |
| TransitRouterAttachmentName | String | 否 | testname |
VBR连接名称。 名称长度为2~128个字符,以大小写字母或中文开头,可包含数字、下划线(_)或短划线(-)。 |
| TransitRouterAttachmentDescription | String | 否 | testdesc |
VBR连接描述。 描述长度为2~256个字符,必须以字母或中文开头,但不能以 |
| VbrId | String | 是 | vbr-bp1svadp4lq38janc**** |
VBR实例ID。 |
| VbrOwnerId | Long | 否 | 1250123456123456 |
VBR实例所属阿里云账号(主账号)ID。默认值为当前登录的阿里云账号ID。 说明 如果您要加载跨账号的网络实例,本参数必填。
|
| AutoPublishRouteEnabled | Boolean | 否 | false |
是否使企业版转发路由器自动发布路由到VBR实例。
|
| DryRun | Boolean | 否 | false |
是否对此次请求执行预检,包括权限、实例状态校验等。取值:
|
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| TransitRouterAttachmentId | String | tr-attach-ia340z7xis7t5s**** |
VBR连接ID。 |
| RequestId | String | C087A369-82B9-43EF-91F4-4B63A9C6E6B6 |
请求ID。 |
示例
请求示例
http(s)://[Endpoint]/?Action=CreateTransitRouterVbrAttachment
&ClientToken=02fb3da4-130e-11e9-8e44-001****
&CenId=cen-j3jzhw1zpau2km****
&TransitRouterId=tr-bp1su1ytdxtataupl****
&RegionId=cn-hangzhou
&TransitRouterAttachmentName=testname
&TransitRouterAttachmentDescription=testdesc
&VbrId=vbr-bp1svadp4lq38janc****
&VbrOwnerId=1250123456123456
&AutoPublishRouteEnabled=false
&DryRun=false
&公共请求参数
正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<CreateTransitRouterVbrAttachmentResponse>
<TransitRouterAttachmentId>tr-attach-ia340z7xis7t5s****</TransitRouterAttachmentId>
<RequestId>C087A369-82B9-43EF-91F4-4B63A9C6E6B6</RequestId>
</CreateTransitRouterVbrAttachmentResponse>
JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"TransitRouterAttachmentId" : "tr-attach-ia340z7xis7t5s****",
"RequestId" : "C087A369-82B9-43EF-91F4-4B63A9C6E6B6"
}
错误码
| HttpCode | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 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 | OperationUnsupported.TransitRouterRegionId | The specified TransitRouterRegion does not support the operation. | 中转地域不支持此操作。 |
| 400 | InvalidCenId.NotFound | CenId is not found. | CEN实例不存在。 |
| 400 | InvalidTransitRouterId.NotFound | TransitRouterId is not found. | 转发路由实例ID不存在。 |
访问错误中心查看更多错误码。