全部产品
Search
文档中心

专有网络 VPC:ListVpcPeerConnections - 查询VPC对等连接列表

更新时间:Mar 03, 2024

调用ListVpcPeerConnections接口查询VPC对等连接的详细信息。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

需要查询详细信息的 VPC 对等连接的地域 ID。

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

cn-hangzhou
InstanceIdstring

需要查询详细信息的 VPC 对等连接实例 ID。

pcc-lnk0m24khwvtkm****
VpcIdarray

根据两端 vpcid 过滤,不区分发起端和接收端。如果只传入一个,则根据一端过滤

string

需要查询详细信息的 VPC 对等连接的发起端或者接收端 VPC 的实例 ID。

vpc-bp1gsk7h12ew7oegk****
Namestring

需要查询详细信息的 VPC 对等连接的名称。

vpcpeer
NextTokenstring

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

  • 第一次查询和没有下一次查询时,均无需填写。
  • 如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。
FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultsinteger

分批次查询时每次显示的条目数。取值范围:1~100,默认值为 20

20
Tagsobject []

标签列表。

Keystring

标签键。最多支持输入 20 个标签键。一旦传入该值,则不允许为空字符串。

一个标签键最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceDept
Valuestring

标签值。最多支持输入 20 个标签值。一旦传入该值,可以为空字符串。

一个标签值最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceJoshua
ResourceGroupIdstring

资源组 ID。

关于资源组的更多信息,请参见什么是资源组

rg-acfmxazb4ph6aiy****

返回参数

名称类型描述示例值
object

请求 ID。

RequestIdstring

请求 ID。

0ED8D006-F706-4D23-88ED-E11ED39DCAC0
TotalCountinteger

列表条目数。

1
MaxResultsinteger

分批次查询时每次显示的条目数。取值范围:1~100,默认值为 20

20
NextTokenstring

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

  • 如果 NextToken 为空表示没有下一次查询。
  • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。
FFmyTO70tTpLG6I3FmYAXGKPd****
VpcPeerConnectsobject []

查询的 VPC 对等连接的详细信息列表。

InstanceIdstring

VPC 对等连接的实例 ID。

pcc-lnk0m24khwvtkm****
GmtCreatestring

VPC 对等连接的创建时间。使用 UTC 时间,格式为YYYY-MM-DDThh:mm:ssZ

2022-04-24T09:02:36Z
GmtModifiedstring

VPC 对等连接的修改时间。使用 UTC 时间,格式为YYYY-MM-DDThh:mm:ssZ

2022-04-24T19:20:45Z
Namestring

VPC 对等连接的名称。

vpcpeer
Descriptionstring

VPC 对等连接的描述信息。

test
OwnerIdlong

VPC 对等连接发起端的阿里云账号 ID。

25346073170691****
AcceptingOwnerUidlong

VPC 对等连接接收端的阿里云账号 ID。

25346073170691****
RegionIdstring

VPC 对等连接发起端的地域 ID。

cn-hangzhou
AcceptingRegionIdstring

VPC 对等连接接收端的地域 ID。

cn-hangzhou
Bandwidthinteger

VPC 对等连接的带宽,单位:Mbps,取值范围为大于 0 的整数。

说明 例外取值-1,表示无带宽限制。

默认值如下:

  • 跨地域 VPC 对等连接的带宽默认值为 1024 Mbps。
  • 同地域 VPC 对等连接的带宽默认值为-1 Mbps,即不限制带宽。
1024
Statusstring

VPC 对等连接的状态。取值:

  • Creating:创建中。
  • Accepting:接收中。
  • Updating:更新中。
  • Rejected:已拒绝。
  • Expired:已过期。
  • Activated:已激活。
  • Deleting:删除中。
  • Deleted:已删除。

关于 VPC 对等连接状态的更多信息,请参见 VPC 对等连接概述

Activated
BizStatusstring

VPC 对等连接的商业状态。取值:

  • Normal:正常。
  • FinancialLocked:欠费锁定。
Normal
GmtExpiredstring

VPC 对等连接的过期时间。使用 UTC 时间,格式为YYYY-MM-DDThh:mm:ssZ

只有当 VPC 对等连接的 Status(状态)为 Accepting(接收中)或 Expired(已过期)时,才会返回具体的过期时间;VPC 对等连接处于其余状态时,返回值为 null

2022-05-01T09:02:36Z
ResourceGroupIdstring

资源组 ID。

rg-acfmxazb4ph6aiy****
Vpcobject

发起端 VPC 实例详细信息。

VpcIdstring

发起端 VPC 实例 ID。

vpc-bp1gsk7h12ew7oegk****
Ipv4Cidrsarray

发起端网段信息。

string

发起端网段信息。

192.168.0.0/16
Ipv6Cidrsarray

发起端 IPv6 网段信息。

string

发起端 IPv6 网段信息。

2408:XXXX:3c5:6e00::/56
AcceptingVpcobject

接收端 VPC 实例详细信息。

VpcIdstring

接收端 VPC 实例 ID。

vpc-bp1vzjkp2q1xgnind****
Ipv4Cidrsarray

接收端网段信息。

string

接收端网段信息。

10.0.0.0/16
Ipv6Cidrsarray

接收端 IPv6 网段信息。

string

接收端 IPv6 网段信息。

2408:XXXX:3b8:3a00::/56
Tagsobject []

标签列表。

Keystring

标签键。

FinanceDept
Valuestring

标签值。

FinanceJoshua

示例

正常返回示例

JSON格式

{
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED39DCAC0",
  "TotalCount": 1,
  "MaxResults": 20,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "VpcPeerConnects": [
    {
      "InstanceId": "pcc-lnk0m24khwvtkm****",
      "GmtCreate": "2022-04-24T09:02:36Z",
      "GmtModified": "2022-04-24T19:20:45Z",
      "Name": "vpcpeer",
      "Description": "test",
      "OwnerId": 0,
      "AcceptingOwnerUid": 0,
      "RegionId": "cn-hangzhou",
      "AcceptingRegionId": "cn-hangzhou",
      "Bandwidth": 1024,
      "Status": "Activated",
      "BizStatus": "Normal",
      "GmtExpired": "2022-05-01T09:02:36Z",
      "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
      "Vpc": {
        "VpcId": "vpc-bp1gsk7h12ew7oegk****",
        "Ipv4Cidrs": [
          "192.168.0.0/16"
        ],
        "Ipv6Cidrs": [
          "2408:XXXX:3c5:6e00::/56"
        ]
      },
      "AcceptingVpc": {
        "VpcId": "vpc-bp1vzjkp2q1xgnind****",
        "Ipv4Cidrs": [
          "10.0.0.0/16"
        ],
        "Ipv6Cidrs": [
          "2408:XXXX:3b8:3a00::/56"
        ]
      },
      "Tags": [
        {
          "Key": "FinanceDept",
          "Value": "FinanceJoshua"
        }
      ]
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-01-23OpenAPI 描述信息更新看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
2023-09-13OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-05-30OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:ResourceGroupId
出参OpenAPI 返回结构发生变更