List VPC peering information

GET

/database/clusters/{clusterId}/vpc-peerings

List VPC peering information

Authorizations

• publicOauth2
  read:database

Parameters

Path Parameters

clusterId

required

string

format: uuid

A cluster ID.

Query Parameters

limit

integer

default: 10

>= 1

<= 100

The maximum number of items to return in a single response. Used for pagination. Must be between 1 and 100.

Example

Example:

10

offset

integer

The number of items to skip before starting to return results. Used for pagination. For example, to get the next 10 items after the first 10, set offset to 10.

Responses

200

A collection of VPC Peering connections

Response Headers

X-Request-Id

string

Example:

b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Collection of VPC peering connections

object

count

required

Number of items returned in the current result set.

integer

Example:

10

meta

required

Pagination metadata for collection responses

object

total

required

Total number of items available

integer

Example:

1000

limit

required

Maximum number of items per page

integer

Example:

10

offset

required

Number of items skipped before the current result set

integer

Example:

10

vpcPeerings

required

Array<object>

Response with information about a VPC peering connection

object

accountId

The ID of the account where the VPC is deployed

string

/^\d{12}$/

Example:

123456789012

vpcId

The ID of the VPC to create a peering connection with

string

/^vpc-([0-9a-f]{8}|[0-9a-f]{17})$/

Example:

vpc-0123456789abcdef0

region

Region where the VPC is deployed

string

default: us-east-1

/^[a-z]{2}-[a-z]+-\d+$/

Example:

us-east-1

status

Status of the VPC peering connection

string

Allowed values:

initiating-request

pending-acceptance

not-operable

provisioning

active

rejected

expired

failed

deleting

deleted

peeringId

The ID of the peering connection

string

Example:

pcx-1410263943e464f4a

cidrBlock

The VPC CIDR block where routing will take place

string

/^\d{1,3}(\.\d{1,3}){3}\/\d{1,2}$/

Example:

192.168.0.0/16

privateHostedZoneId

The ID of the private hosted zone that the VPC should associate with

string

Example:

Z04089311NGVVH0FO3QGG

isSecureConnection

Flag to set up tls or non tls vpc peering connection

boolean

default: true

Example

Content type: application/json

Copied!

{ 

{

"count": 10,

"meta": { 

"total": 1000,

"limit": 10,

"offset": 10

},

"vpcPeerings": [ 

{ 

"accountId": "123456789012",

"vpcId": "vpc-0123456789abcdef0",

"region": "us-east-1",

"status": "initiating-request",

"peeringId": "pcx-1410263943e464f4a",

"cidrBlock": "192.168.0.0/16",

"privateHostedZoneId": "Z04089311NGVVH0FO3QGG",

"isSecureConnection": "boolean"

}

]

}

401

Access token is missing or invalid

Response Headers

X-Request-Id

string

Example:

b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object

code

Unique (system-wide) error code for an error happened

string

message

required

Developer-friendly message explaining error

string

key

additional properties

any

Example

Content type: application/json

Copied!

{ 

{

"code": "invalid_token",

"message": "The access token expired."

}

403

Permission denied

Response Headers

X-Request-Id

string

Example:

b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object

code

Unique (system-wide) error code for an error happened

string

message

required

Developer-friendly message explaining error

string

key

additional properties

any

Example

Content type: application/json

Copied!

{ 

{

"code": "string",

"message": "string"

}

404

Resource not found

Response Headers

X-Request-Id

string

Example:

b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object

code

Unique (system-wide) error code for an error happened

string

message

required

Developer-friendly message explaining error

string

key

additional properties

any

Example

Content type: application/json

Copied!

{ 

{

"code": "string",

"message": "string"

}

500

Internal Server Error

Response Headers

X-Request-Id

string

Example:

b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object

code

Unique (system-wide) error code for an error happened

string

message

required

Developer-friendly message explaining error

string

key

additional properties

any

Example

Content type: application/json

Copied!

{ 

{

"code": "string",

"message": "string"

}