Function

This API is used to query all VPC peering connections accessible to the tenant submitting the request. The connections are filtered based on the filtering condition. For details about pagination query, see section Pagination.

URI

GET /v2.0/vpc/peerings

Example:

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}

Request Message

• Request parameter

  None

• Example request

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

Response Message

• Response parameter

  Table 2 Response parameter

  Parameter	Type	Description
  peerings	Array of peering objects	Specifies the VPC peering connection object list. For details, see Table 3.
  peerings_links	Array of peerings_link objects	Specifies the VPC peering connection object list. For details, see Table 5.

  Table 3 peering objects

  Attribute	Type	Description
  id	String	Specifies the VPC peering connection ID.
  name	String	Specifies the VPC peering connection name.
  status	String	Specifies the VPC peering connection status. Possible values are as follows: PENDING_ACCEPTANCE REJECTED EXPIRED DELETED ACTIVE
  request_vpc_info	Object	Specifies information about the local VPC. For details, see Table 4.
  accept_vpc_info	Object	Specifies information about the peer VPC. For details, see Table 4.
  description	String	Provides supplementary information about the VPC peering connection.
  created_at	String	Specifies the time (UTC) when the VPC peering connection is created. Format: yyyy-MM-ddTHH:mm:ss
  updated_at	String	Specifies the time (UTC) when the VPC peering connection is updated. Format: yyyy-MM-ddTHH:mm:ss

  Table 4 vpc_info objects

  Attribute	Type	Description
  vpc_id	String	Specifies the ID of a VPC involved in a VPC peering connection.
  tenant_id	String	Specifies the ID of the project to which a VPC involved in the VPC peering connection belongs.

  Table 5 peerings_link object

  Name	Type	Description
  href	String	Specifies the API link.
  rel	String	Specifies the relationship between the API link and the API version.

• Example response

  {
      "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",
              "id": "b147a74b-39bb-4c7a-aed5-19cac4c2df13",
              "status": "ACTIVE"
          }
      ]
  }

Status Code

See Status Codes.

Error Code

See Error Codes.