调用ListTransitRouterVbrAttachments查询边界路由器VBR连接信息

调用ListTransitRouterVbrAttachments接口查询企业版转发路由器下的边界路由器VBR总条目数、连接的状态、连接 ID、网络实例的付费方等连接信息。

接口说明

您可以通过以下三种方式查询企业版转发路由器下 VBR 连接的信息：

通过企业版转发路由器实例 ID 查询该实例下所有 VBR 连接的信息。
通过云企业网实例 ID 和企业版转发路由器实例所属地域 ID 查询该实例下所有 VBR 连接的信息。
可以单独通过 TransitRouterAttachmentId 参数查询 VBR 连接信息。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
cen:ListTransitRouterVbrAttachments	list	CenInstance acs:cen::{#accountId}:ceninstance/{#ceninstanceId} TransitRouterVbrAttachment acs:cen::{#accountId}:centransitrouterattachment/* TransitRouterVbrAttachment acs:cen:*:{#accountId}:centransitrouterattachment/{#centransitrouterattachmentId}	无	无

请求参数

名称	类型	必填	描述	示例值
CenId	string	否	云企业网实例 ID。	cen-j3jzhw1zpau2km****
RegionId	string	否	企业版转发路由器实例所属地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-hangzhou
TransitRouterAttachmentId	string	否	VBR 连接 ID。	tr-attach-oyf70wfuorwx87****
TransitRouterId	string	否	企业版转发路由器实例 ID。	tr-bp1su1ytdxtataupl****
MaxResults	integer	否	分批次查询时，每次显示的最大条目数。默认值为 20。	20
NextToken	string	否	是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次 API 调用返回的 NextToken 值。	dd20****
Tag	array<object>	否	标签信息。一次最多支持输入 20 个标签信息。
	object	否
Key	string	否	资源的标签键。一旦传入该值，则不允许为空字符串。最多支持 64 个字符，不能以`aliyun`或者`acs:`开头，不能包含`http://`或者`https://` 。一次最多支持输入 20 个标签的标签键。	tagtest
Value	string	否	资源的标签值。标签值可以为空或输入不超过 128 个字符的字符串，不能以`aliyun`或者`acs:`开头，不能包含`http://`或者`https://` 。每一个标签键对应一个标签值，一次最多支持输入 20 个标签键对应的标签值。	tagtest

返回参数

名称	类型	描述	示例值
	object	返回结果。
NextToken	string	是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次 API 调用返回的 NextToken 值。	dd20****
RequestId	string	请求 ID。	F42D9616-29EB-4E75-8CA8-9654D4E07501
TotalCount	integer	总条目数。	1
MaxResults	integer	分批次查询时，每次显示的最大条目数。	20
TransitRouterAttachments	array<object>	VBR 连接信息列表。
TransitRouterAttachment	object
CreationTime	string	VBR 连接的创建时间。时间按照 ISO8601 标准表示，并使用 UTC 时间。格式为：YYYY-MM-DDThh:mmZ。	2021-06-15T15:20Z
Status	string	VBR 连接的状态。 Attached：已加载。 Attaching：加载中。 Detaching：卸载中。	Attached
TransitRouterAttachmentId	string	VBR 连接 ID。	tr-attach-oyf70wfuorwx87****
TransitRouterId	string	企业版转发路由器实例 ID。	tr-bp1su1ytdxtataupl****
ResourceType	string	连接所属的资源类型。仅取值：VBR，表示边界路由器实例。	VBR
VbrRegionId	string	VBR 实例所属地域 ID。	cn-hangzhou
TransitRouterAttachmentDescription	string	VBR 连接的描述信息。	testdesc
VbrOwnerId	long	VBR 实例所属账号 ID。	1688111111111111
AutoPublishRouteEnabled	boolean	企业版转发路由器是否自动发布路由到 VBR 实例。 false：否。 true：是。	false
VbrId	string	VBR 实例 ID。	vbr-bp1svadp4lq38janc****
TransitRouterAttachmentName	string	VBR 连接的名称。	testa
Tags	array<object>	标签列表。
Tag	object
Key	string	标签键。	test
Value	string	标签值。	value_A1
CenId	string	云企业网实例 ID。	cen-j3jzhw1zpau2km****
OrderType	string	网络实例的付费方。取值： PayByCenOwner：表示 VBR 实例的连接费和流量处理费由转发路由器实例所属的账号承担。 PayByResourceOwner：表示 VBR 实例的连接费和流量处理费由 VBR 实例所属的账号承担。	PayByCenOwner

示例

正常返回示例

JSON格式

{
  "NextToken": "dd20****",
  "RequestId": "F42D9616-29EB-4E75-8CA8-9654D4E07501",
  "TotalCount": 1,
  "MaxResults": 20,
  "TransitRouterAttachments": [
    {
      "CreationTime": "2021-06-15T15:20Z",
      "Status": "Attached",
      "TransitRouterAttachmentId": "tr-attach-oyf70wfuorwx87****",
      "TransitRouterId": "tr-bp1su1ytdxtataupl****",
      "ResourceType": "VBR",
      "VbrRegionId": "cn-hangzhou",
      "TransitRouterAttachmentDescription": "testdesc",
      "VbrOwnerId": 1688111111111111,
      "AutoPublishRouteEnabled": false,
      "VbrId": "vbr-bp1svadp4lq38janc****",
      "TransitRouterAttachmentName": "testa",
      "Tags": [
        {
          "Key": "test",
          "Value": "value_A1"
        }
      ],
      "CenId": "cen-j3jzhw1zpau2km****\n",
      "OrderType": "PayByCenOwner"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	IllegalParam.NextToken	The specified NextToken is invalid.	NextToken是无效的。
400	IllegalParam.TrInstance	The specified TransitRouter is invalid.	TransitRouter是无效的。
400	IllegalParam.Region	The specified Region is invalid.	参数中指定的Region不合法。
400	IllegalParam.CenId	The specified CenId is invalid.	云企业网实例ID非法。
400	IllegalParam.TransitRouterId	The specified TransitRouterId is invalid.	参数中指定的TransitRouterId不合法。
400	IllegalParam.CenIdOrRegionId	The specified CenId or RegionId is invalid.	指定的CenId或RegionId不合法。
400	IllegalParam.MaxResults	The specified MaxResults is illegal.	MaxResults非法。
400	InvalidParameter	Invalid parameter.	参数不合法。
400	Unauthorized	The AccessKeyId is unauthorized.	账号无权限操作。

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

变更历史

变更时间	变更内容概要	操作
2023-12-26	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-10-20	OpenAPI 错误码发生变更	查看变更详情
2023-08-04	OpenAPI 错误码发生变更	查看变更详情
2023-03-01	OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情