Querying a VPC Peering Connection

Function

This API is used to query details about a VPC peering connection.

URI

GET /v2.0/vpc/peerings/{peering_id}

Request Message

• Request parameter

  None

• Example request

  GET https://{Endpoint}/v2.0/vpc/peerings/22b76469-08e3-4937-8c1d-7aad34892be1

Response Message

• Response parameter

  Table 2 Response parameter

  Parameter	Type	Description
  peering	peering object	Specifies the VPC peering connection object list. For details, see Table 3.

  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	vpc_info object	Specifies information about the local VPC. For details, see Table 4.
  accept_vpc_info	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.

• Example response

  { 
      "peering": { 
          "name": "test", 
          "id": "22b76469-08e3-4937-8c1d-7aad34892be1",
          "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"
          }, 
          "status": "ACTIVE"
      }
  }

Status Code

See Status Codes.

Error Code

See Error Codes.