全部产品
Search
文档中心

云企业网:ListTransitRouterVbrAttachments - 查询企业版转发路由器下的边界路由器VBR连接信息

更新时间:Apr 11, 2023

查询企业版转发路由器下的边界路由器VBR(Virtual border router)连接信息。

接口说明

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

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

调试

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

调试

授权信息

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

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

请求参数

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

云企业网实例ID。

cen-j3jzhw1zpau2km****
RegionIdstring

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

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

cn-hangzhou
TransitRouterAttachmentIdstring

VBR连接ID。

tr-attach-oyf70wfuorwx87****
TransitRouterIdstring

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

tr-bp1su1ytdxtataupl****
MaxResultsinteger

分批次查询时,每次显示的最大条目数。默认值为20

20
NextTokenstring

分批次查询时,下一次查询的Token。

dd20****
Tagarray

标签信息。

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

object
Keystring

资源的标签键。

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

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

tagtest
Valuestring

资源的标签值。

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

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

tagtest

返回参数

名称类型描述示例值
object

返回结果。

NextTokenstring

分批次查询时,下一次查询的Token。

dd20****
RequestIdstring

请求ID。

F42D9616-29EB-4E75-8CA8-9654D4E07501
TotalCountinteger

总条目数。

1
MaxResultsinteger

分批次查询时,每次显示的最大条目数。

20
TransitRouterAttachmentsarray

VBR连接信息列表。

object
CreationTimestring

VBR连接的创建时间。

时间按照ISO8601标准表示,并使用UTC时间。格式为:YYYY-MM-DDThh:mmZ。

2021-06-15T15:20Z
Statusstring

VBR连接的状态。

  • Attached:已加载。
  • Attaching:加载中。
  • Detaching:卸载中。
  • Detached:已卸载。
Attached
TransitRouterAttachmentIdstring

VBR连接ID。

tr-attach-oyf70wfuorwx87****
TransitRouterIdstring

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

tr-bp1su1ytdxtataupl****
ResourceTypestring

连接所属的资源类型。

  • VPC:专有网络实例。
  • CCN:云连接网实例。
  • VBR:边界路由器实例。
  • TR:转发路由器实例。
VBR
VbrRegionIdstring

VBR实例所属地域ID。

cn-hangzhou
TransitRouterAttachmentDescriptionstring

VBR连接的描述信息。

testdesc
VbrOwnerIdlong

VBR实例所属账号ID。

1688111111111111
AutoPublishRouteEnabledboolean

企业版转发路由器是否自动发布路由到VBR实例。

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

VBR实例ID。

vbr-bp1svadp4lq38janc****
TransitRouterAttachmentNamestring

VBR连接的名称。

testa
Tagsarray

标签列表。

object
Keystring

标签键。

test
Valuestring

标签值。

value_A1
CenIdstring

云企业网实例ID。

cen-j3jzhw1zpau2km****

示例

正常返回示例

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"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400IllegalParam.NextTokenThe specified NextToken is invalid.NextToken是无效的。
400IllegalParam.TrInstanceThe specified TransitRouter is invalid.TransitRouter是无效的。
400IllegalParam.RegionThe specified Region is invalid.参数中指定的Region不合法。
400IllegalParam.CenIdThe specified CenId is invalid.云企业网实例ID非法。
400IllegalParam.TransitRouterIdThe specified TransitRouterId is invalid.参数中指定的TransitRouterId不合法。
400IllegalParam.CenIdOrRegionIdThe specified CenId or RegionId is invalid.指定的CenId或RegionId不合法。
400InvalidParameterInvalid parameter.参数不合法。
400UnauthorizedThe AccessKeyId is unauthorized.账号无权限操作。

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

变更历史

变更时间变更内容概要操作
2023-03-01OpenAPI 描述信息更新,OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更