文档首页/ 虚拟私有云 VPC/ API参考/ API V1/V2/ 对等连接/ 查询对等连接信息列表 - ListVpcPeeringInfos
更新时间:2026-10-14 GMT+08:00
分享

查询对等连接信息列表 - ListVpcPeeringInfos

功能介绍

当您的对等连接创建成功后,您可以通过该接口查询所有对等连接信息,包括对等连接的名称、两端vpc的信息等

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v2.0/vpc/peering-infos

表1 Query参数

参数

是否必选

参数类型

描述

id

否

Array of strings

参数解释:

对等连接的资源ID,填写后按照ID进行过滤,支持传入多个ID过滤。

取值范围:

不涉及。

limit

否

Integer

参数解释:

每页返回的资源个数。

取值范围:

0~2000。

缺省值:2000

marker

否

String

参数解释:

分页查询起始的资源ID,为空时查询第一页。

取值范围:

对等连接的资源ID。

name

否

Array of strings

参数解释:

对等连接的名称,填写后按照名称进行过滤,支持传入多个名称过滤。

取值范围:

不涉及。

status

否

String

参数解释:

对等连接的状态,填写后按照状态进行过滤。

取值范围:

  • PENDING_ACCEPTANCE:等待接受

  • REJECTED:已拒绝。

  • EXPIRED:已过期。

  • DELETED:已删除。

  • ACTIVE:生效的。

tenant_id

否

String

参数解释:

对等连接的项目ID,填写后按照项目ID进行过滤。

取值范围:

不涉及。

vpc_id

否

Array of strings

参数解释:

对等连接两端的VPC ID,填写后按照VPC ID进行过滤,支持传入多个ID过滤。

取值范围:

不涉及。

请求参数

无

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

peering_infos

Array of VpcPeering objects

对等连接信息对象列表

peering_infos_links

Array of NeutronPageLink objects

分页信息

表3 VpcPeering

参数

参数类型

描述

id

String

对等连接ID

name

String

功能说明:对等连接名称

取值范围:支持1~64个字符

最小长度:1

最大长度:64

status

String

功能说明:对等连接状态

取值范围:

  • PENDING_ACCEPTANCE:等待接受

  • REJECTED:已拒绝。

  • EXPIRED:已过期。

  • DELETED:已删除。

  • ACTIVE:活动的。

request_vpc_info

VpcInfo object

对等连接发起端vpc信息

accept_vpc_info

VpcInfo object

对等连接接受端vpc信息

created_at

String

功能说明:资源创建UTC时间

格式:yyyy-MM-ddTHH:mm:ss

updated_at

String

功能说明:资源更新UTC时间

格式:yyyy-MM-ddTHH:mm:ss

description

String

对等连接描述

表4 VpcInfo

参数

参数类型

描述

vpc_id

String

对等连接其中一端vpc ID

tenant_id

String

对等连接其中一端vpc所属的租户ID

约束:跨租户VPC创建对等连接时必选

请求示例

  • 分页过滤查询结果,每页返回limit个数据,从第marker数据之后返回。

    GET https://{Endpoint}/v2.0/vpc/peering-infos?limit=10&marker=10b932da-f95c-4003-a77d-4064b7d101cd
  • 分页过滤查询结果,每页返回的个数为1。

    GET https://{Endpoint}/v2.0/vpc/peering-infos?limit=1
  • 查询对等连接列表。

    GET https://{Endpoint}/v2.0/vpc/peering-infos

响应示例

状态码:200

{
  "peering_infos": [
    {
      "id": "195e6366-39b7-42ec-b7ce-4c8102bdfafd",
      "name": "peering-81cf",
      "status": "ACTIVE",
      "description": "",
      "request_vpc_info": {
        "name": "vpc-1",
        "vpc_id": "b2e0f0be-7454-48cf-a833-f46fe224b254",
        "tenant_id": "060576782980d5762f9ec014dd2f1148"
      },
      "accept_vpc_info": {
        "name": "vpc-2",
        "vpc_id": "b61c74a1-aa59-4316-87d7-6366f7b48872",
        "tenant_id": "060576782980d5762f9ec014dd2f1148"
      },
      "created_at": 2019-11-22T03:56:14.000+00:00,
      "updated_at": 2019-11-22T03:56:14.000+00:00,
      "total": 2
    },
    {
      "id": "3049c814-1e39-4a74-a263-375c6fb1c12d",
      "name": "peering-28ae",
      "status": "ACTIVE",
      "description": "",
      "request_vpc_info": {
        "name": "vpc-3",
        "vpc_id": "db28e2f1-85c8-4135-a568-cb47e290d70e",
        "tenant_id": "060576782980d5762f9ec014dd2f1148"
      },
      "accept_vpc_info": {
        "name": "vpc-4",
        "vpc_id": "b61c74a1-aa59-4316-87d7-6366f7b48872",
        "tenant_id": "060576782980d5762f9ec014dd2f1148"
      },
      "created_at": 2019-11-18T07:02:08.000+00:00,
      "updated_at": 2019-11-18T07:02:08.000+00:00,
      "total": 2
    }
  ]
}

状态码

状态码

描述

200

GET操作正常返回,更多状态码请参见状态码。

错误码

请参见错误码。

相关文档