ListTransitRouterVpcAttachments - 查询企业版转发路由器下专有网络VPC连接的信息

调用ListTransitRouterVpcAttachments接口查询企业版转发路由器下专有网络VPC(Virtual Private Cloud)VPC连接的状态、VPC连接的付费类型、VPC连接的可用区信息及其关联的VPC实例的交换机和弹性网卡信息等。

接口说明

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

  • 通过企业版转发路由器实例 ID 查询该实例下所有 VPC 连接的信息。

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

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cen:ListTransitRouterVpcAttachments

list

*CenInstance

acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}

TransitRouterVpcAttachment

acs:cen:*:{#accountId}:centransitrouterattachment/*

TransitRouterVpcAttachment

acs:cen:*:{#accountId}:centransitrouterattachment/{#centransitrouterattachmentId}

请求参数

名称

类型

必填

描述

示例值

CenId

string

云企业网实例 ID。

cen-j3jzhw1zpau2km****

RegionId

string

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

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

cn-hangzhou

TransitRouterAttachmentId

string

VPC 连接 ID。

tr-attach-nls9fzkfat8934****

TransitRouterId

string

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

tr-bp1su1ytdxtataupl****

MaxResults

integer

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

20

NextToken

string

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。

  • 如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。

FFmyTO70tTpLG6I3FmYAXGKPd****

Tag

array

标签信息。

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

object

Key

string

资源的标签键。

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

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

tagtest

Value

string

资源的标签值。

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

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

tagtest

VpcId

string

VPC 实例 ID。

vpc-bp1kbjcre9vtsebo1****

OrderType

string

网络实例的付费方。取值:

  • PayByCenOwner:表示网络实例产生的费用由云企业网实例所属的账号承担。

  • PayByResourceOwner:表示网络实例产生的费用由网络实例所属的账号承担。

PayByCenOwner

Status

string

网络实例的加载状态。

  • Attaching:加载中。

  • Attached:已加载。

  • Detaching:卸载中。

Attached

返回参数

名称

类型

描述

示例值

object

返回结果。

NextToken

string

是否拥有下一次查询的令牌(Token)。取值:

  • 如果 NextToken 为空表示没有下一次查询。

  • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。

FFmyTO70tTpLG6I3FmYAXGKPd****

RequestId

string

请求 ID。

C97FF53F-3EF8-4883-B459-60E171924B23

TotalCount

integer

总条目数。

1

MaxResults

integer

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

20

TransitRouterAttachments

array

VPC 连接信息列表。

object

VPC 连接信息列表。

CreationTime

string

VPC 连接的创建时间。

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

2021-06-15T02:14Z

Status

string

VPC 连接的状态。

  • Attached:已加载。

  • Attaching:加载中。

  • Detaching:卸载中。

Attached

VpcId

string

VPC 实例 ID。

vpc-bp1h8vbrbcgohcju5****

TransitRouterAttachmentId

string

VPC 连接 ID。

tr-attach-nls9fzkfat8934****

TransitRouterId

string

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

tr-bp1su1ytdxtataupl****

ResourceType

string

连接所属的资源类型。

仅取值:VPC,表示专有网络实例。

VPC

TransitRouterAttachmentDescription

string

VPC 连接的描述信息。

testdesc

VpcOwnerId

integer

VPC 实例所属账号 ID。

1250123456123456

VpcRegionId

string

VPC 实例所属地域 ID。

cn-hangzhou

TransitRouterAttachmentName

string

VPC 连接的名称。

testname

ZoneMappings

array

VPC 连接的可用区信息及其关联的 VPC 实例的交换机和弹性网卡的信息。

object

ZoneId

string

可用区 ID。

cn-hangzhou-h

VSwitchId

string

交换机 ID。

vsw-bp1a214sbus8z3b54****

NetworkInterfaceId

string

企业版转发路由器在交换机中创建的弹性网卡的 ID。

eni-bp149hmyaqegerml****

AutoPublishRouteEnabled

boolean

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

  • false:否。

  • true:是。

true

ChargeType

string

VPC 连接的付费类型。

仅取值:POSTPAY,表示按使用量后付费。

POSTPAY

Tags

array

标签信息。

object

Key

string

标签键。

test

Value

string

标签值。

test

OrderType

string

网络实例的付费方。取值:

  • PayByCenOwner:表示网络实例产生的费用由云企业网实例所属的账号承担。

  • PayByResourceOwner:表示网络实例产生的费用由网络实例所属的账号承担。

PayByCenOwner

ManagedService

string

归属云服务。

SAS

TransitRouterVPCAttachmentOptions

object

VPC 连接的功能属性列表。

string

VPC 连接的功能属性。

  • ipv6Support:是否已开启 IPv6 功能。默认值为当前 VPC 连接 IPv6 功能开启的状态。

    • enable:已开启 IPv6 功能。

    • disable:未开启 IPv6 功能。

{ "ipv6Support": "disable" }

CenId

string

云企业网实例 ID。

cen-j3jzhw1zpau2km****

示例

正常返回示例

JSON格式

{
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "C97FF53F-3EF8-4883-B459-60E171924B23",
  "TotalCount": 1,
  "MaxResults": 20,
  "TransitRouterAttachments": [
    {
      "CreationTime": "2021-06-15T02:14Z",
      "Status": "Attached",
      "VpcId": "vpc-bp1h8vbrbcgohcju5****",
      "TransitRouterAttachmentId": "tr-attach-nls9fzkfat8934****",
      "TransitRouterId": "tr-bp1su1ytdxtataupl****",
      "ResourceType": "VPC",
      "TransitRouterAttachmentDescription": "testdesc",
      "VpcOwnerId": 1250123456123456,
      "VpcRegionId": "cn-hangzhou",
      "TransitRouterAttachmentName": "testname",
      "ZoneMappings": [
        {
          "ZoneId": "cn-hangzhou-h",
          "VSwitchId": "vsw-bp1a214sbus8z3b54****",
          "NetworkInterfaceId": "eni-bp149hmyaqegerml****"
        }
      ],
      "AutoPublishRouteEnabled": true,
      "ChargeType": "POSTPAY",
      "Tags": [
        {
          "Key": "test",
          "Value": "test"
        }
      ],
      "OrderType": "PayByCenOwner",
      "ManagedService": "SAS",
      "TransitRouterVPCAttachmentOptions": {
        "key": "{ \"ipv6Support\": \"disable\" }"
      },
      "CenId": "cen-j3jzhw1zpau2km****\n"
    }
  ]
}

错误码

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. 指定的CenIdRegionId不合法。
400 IllegalParam.MaxResults The specified MaxResults is illegal. MaxResults非法。
400 InvalidParameter Invalid parameter. 参数不合法。
400 Unauthorized The AccessKeyId is unauthorized. 账号无权限操作。

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

变更历史

更多信息,参考变更详情