Updated on 2026-10-27 GMT+08:00

Querying the Information of VPC Peering Connections

Function

This API is used to query information about all VPC peering connections, including the names of the VPC peering connections and information about the VPCs at both ends.

Debugging

You can debug this API through automatic authentication in API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v2.0/vpc/peering-infos

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
id	No	Array of strings	Definition VPC peering connection ID. If this parameter is specified, resources are filtered by ID. Multiple IDs can be specified for filtering. Range N/A
limit	No	Integer	Definition Number of resources returned on each page. Range 0 to 2000 Default: 2000
marker	No	String	Definition Start resource ID of pagination query. If the parameter is left blank, only resources on the first page are queried. Range The value can be the ID of a VPC peering connection.
name	No	Array of strings	Definition VPC peering connection name. If this parameter is specified, resources are filtered by name. Multiple names can be specified for filtering. Range N/A
status	No	String	Definition VPC peering connection status. If this parameter is specified, resources are filtered by status. Range PENDING_ACCEPTANCE REJECTED EXPIRED DELETED ACTIVE
tenant_id	No	String	Definition Project ID of the VPC peering connection. If this parameter is specified, VPC peering connections are filtered by project ID. Range N/A
vpc_id	No	Array of strings	Definition IDs of the VPCs that the VPC peering connection connects. If this parameter is specified, VPC peering connections are filtered by VPC ID. Multiple VPC IDs can be specified. Range N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
peering_infos	Array of VpcPeering objects	List of VPC peering connection objects.
peering_infos_links	Array of NeutronPageLink objects	Pagination information.

**Table 3** VpcPeering
Parameter	Type	Description
id	String	VPC peering connection ID.
name	String	Definition: VPC peering connection name. Range: The value can contain 1 to 64 characters. Minimum: 1 Maximum: 64
status	String	Definition: VPC peering connection status. Range: PENDING_ACCEPTANCE REJECTED EXPIRED DELETED ACTIVE
request_vpc_info	VpcInfo object	Information about the local VPC.
accept_vpc_info	VpcInfo object	Information about the peer VPC.
created_at	String	Definition: Time (UTC) when a resource was created. Format: yyyy-MM-ddTHH:mm:ss
updated_at	String	Definition: Time (UTC) when a resource was updated. Format: yyyy-MM-ddTHH:mm:ss
description	String	Supplementary information about the VPC peering connection.

**Table 4** VpcInfo
Parameter	Type	Description
vpc_id	String	ID of the VPC at one end of the VPC peering connection.
tenant_id	String	ID of the tenant that a VPC involved in the VPC peering connection belongs to. Constraints: This parameter is mandatory if you create a cross-tenant VPC peering connection.

**Table 5** NeutronPageLink
Parameter	Type	Description
href	String	API link.
rel	String	Relationship between the API link and the API version.

Example Requests

Filter the query results by page. Each page returns limit records, starting from the one specified by marker.
```
GET https://{Endpoint}/v2.0/vpc/peering-infos?limit=10&marker=10b932da-f95c-4003-a77d-4064b7d101cd
```
Filter the query results by page. Each page returns one record.
```
GET https://{Endpoint}/v2.0/vpc/peering-infos?limit=1
```

Query the list of VPC peering connections.

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

Example Responses

Status code: 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
    }
  ]
}

Status Codes

Status Code	Description
200	The GET operation is successful. For more status codes, see Status Codes.

Error Codes

See Error Codes.

Parent Topic: VPC Peering Connection