文档首页/虚拟私有云 VPC/API参考/API V1/V2/对等连接/查询对等连接列表 - ListVpcPeerings
更新时间：2025-12-23 GMT+08:00
查看PDF
分享

查询对等连接列表 - ListVpcPeerings

功能介绍

查询提交请求的租户的所有对等连接。根据过滤条件进行过滤。分页查询请参考分页查询。

授权信息

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

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    vpc:peerings:list

    List

    peering *

    -

    • vpc:peerings:get

    -

URI

GET /v2.0/vpc/peerings

样例：

GET https://{Endpoint}/v2.0/vpc/peerings?id={id}&name={name}&status={status}&tenant_id={tenant_id}&vpc_id={vpc_id}&limit={limit}&marker={marker}
参数说明请参见表1。
表1 参数说明

名称

是否必选

参数类型

说明

id

否

String

按照peering_id过滤查询。

name

否

String

  • 功能说明：按照peering_name过查询。
  • 取值范围：最大长度不超过64。

status

否

String

按照status进行过滤。

取值范围：

  • PENDING_ACCEPTANCE：等待接受。
  • REJECTED：已拒绝。
  • EXPIRED：已过期。
  • DELETED：已删除。
  • ACTIVE：活动的。

tenant_id

否

String

按照tenant_id过滤查询。

vpc_id

否

String

按照vpc_id过滤查询。

marker

否

String

分页查询的起始资源ID，表示从指定资源的下一条记录开始查询。

marker需要和limit配合使用：

  • 若不传入marker和limit参数，查询结果返回第一页全部资源记录。
  • 若不传入marker参数，limit为10，查询结果返回第1~10条资源记录。
  • 若marker为第10条记录的资源ID，limit为10，查询结果返回第11~20条资源记录。
  • 若marker为第10条记录的资源ID，不传入limit参数，查询结果返回第11~2000条（limit默认值2000）资源记录。

limit

否

Integer

分页查询每页返回的记录个数，取值范围为0~2000，默认值2000。

limit需要和marker配合使用，详细规则请见marker的参数说明。

默认值为2000。

请求参数

无

请求示例

GET https://{Endpoint}/v2.0/vpc/peerings

响应参数

表2 响应参数

参数名称

类型

说明

peerings

Array of peering objects

peering对象列表，参见表3。

peerings_links

Array of peerings_link objects

peerings_link对象列表，参见表5。

只有在使用limit过滤，并且资源个数超过limit或者资源个数超过2000时（limit默认值），该参数的rel和href取值才会显示为next和其对应的link。

表3 peering对象

参数名称

类型

说明

id

String

对等连接id。

name

String

对等连接的名称。

status

String

状态：

  • PENDING_ACCEPTANCE：等待接受
  • REJECTED：已拒绝。
  • EXPIRED：已过期。
  • DELETED：已删除。
  • ACTIVE：活动的。

request_vpc_info

vpc_info object

对等连接发起端vpc信息，请参见表4。

accept_vpc_info

vpc_info object

对等连接接受端vpc信息，请参见表4。

description

String

对等连接描述。

created_at

String

  • 功能说明：资源创建时间，UTC时间。
  • 格式：yyyy-MM-ddTHH:mm:ss

updated_at

String

  • 功能说明：资源更新时间，UTC时间。
  • 格式：yyyy-MM-ddTHH:mm:ss
表4 vpc_info对象

参数名称

类型

说明

vpc_id

String

对等连接其中一端vpc id。

tenant_id

String

对等连接其中一端vpc所属的项目id。

表5 peerings_link对象

名称

参数类型

说明

href

String

API链接。

rel

String

API链接与该API版本的关系。

响应示例

{
    "peerings": [
        {
            "request_vpc_info": {
                "vpc_id": "9daeac7c-a98f-430f-8e38-67f9c044e299",
                "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e"
            },
            "accept_vpc_info": {
                "vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5",
                "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e"
            },
            "name": "test",
            "description": "test",
            "id": "b147a74b-39bb-4c7a-aed5-19cac4c2df13",
            "status": "ACTIVE"
        }
    ]
}

状态码

请参见状态码。

错误码

请参考错误码。

父主题： 对等连接