List VPC peering information
GET /database/clusters/{clusterId}/vpc-peerings
List VPC peering information
Authorizations
Parameters
Path Parameters
A cluster ID.
Query Parameters
The maximum number of items to return in a single response. Used for pagination. Must be between 1 and 100.
Example
Example: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
ID uniquely identifying the request/response cycle.
Response Schema
Collection of VPC peering connections
object
Number of items returned in the current result set.
Pagination metadata
object
Total number of items available
Maximum number of items per page
Number of items skipped before the current result set
object
Unique identifier for this resource within Aerospike Cloud
The ID of the account where the VPC is deployed
The ID of the VPC to create a peering connection with
Region where the VPC is deployed
Status of the VPC peering connection
The AWS-generated ID of the peering connection (PCX ID)
The VPC CIDR block where routing will take place
The ID of the private hosted zone that the VPC should associate with
Flag to set up tls or non tls vpc peering connection
Example
{
"meta": {
"vpcPeerings": [
{
401
Access token is missing or invalid
Response Headers
ID uniquely identifying the request/response cycle.
Response Schema
RFC 9457 Problem Details for HTTP APIs. Provides a standardized format for conveying error details in HTTP responses.
object
URN-based error type identifiers following the pattern: urn:aerospike:errors:{category}:{specific}
Resource information (cluster, database, organization, etc.) is provided in the ProblemDetails context field, not in the URN.
A short, human-readable summary of the problem type
The HTTP status code
A human-readable explanation specific to this occurrence
A URI reference that identifies the specific occurrence
Context for resource-related errors (not-found, already-exists)
object
Type of resource (e.g., cluster, database, organization)
Identifier of the resource
Structured context for validation errors
object
JSON Pointer paths to missing required fields
Details about invalid field values
object
JSON Pointer path to the invalid field
URN identifying the specific validation error type
An optional human-readable description of the validation error
object
Developer-friendly message explaining the error. Deprecated: Use ‘detail’ field instead.
Example
Example:403
Permission denied
Response Headers
ID uniquely identifying the request/response cycle.
Response Schema
RFC 9457 Problem Details for HTTP APIs. Provides a standardized format for conveying error details in HTTP responses.
object
URN-based error type identifiers following the pattern: urn:aerospike:errors:{category}:{specific}
Resource information (cluster, database, organization, etc.) is provided in the ProblemDetails context field, not in the URN.
A short, human-readable summary of the problem type
The HTTP status code
A human-readable explanation specific to this occurrence
A URI reference that identifies the specific occurrence
Context for resource-related errors (not-found, already-exists)
object
Type of resource (e.g., cluster, database, organization)
Identifier of the resource
Structured context for validation errors
object
JSON Pointer paths to missing required fields
Details about invalid field values
object
JSON Pointer path to the invalid field
URN identifying the specific validation error type
An optional human-readable description of the validation error
object
Developer-friendly message explaining the error. Deprecated: Use ‘detail’ field instead.
Example
Example:404
Resource not found
Response Headers
ID uniquely identifying the request/response cycle.
Response Schema
RFC 9457 Problem Details for HTTP APIs. Provides a standardized format for conveying error details in HTTP responses.
object
URN-based error type identifiers following the pattern: urn:aerospike:errors:{category}:{specific}
Resource information (cluster, database, organization, etc.) is provided in the ProblemDetails context field, not in the URN.
A short, human-readable summary of the problem type
The HTTP status code
A human-readable explanation specific to this occurrence
A URI reference that identifies the specific occurrence
Context for resource-related errors (not-found, already-exists)
object
Type of resource (e.g., cluster, database, organization)
Identifier of the resource
Structured context for validation errors
object
JSON Pointer paths to missing required fields
Details about invalid field values
object
JSON Pointer path to the invalid field
URN identifying the specific validation error type
An optional human-readable description of the validation error
object
Developer-friendly message explaining the error. Deprecated: Use ‘detail’ field instead.
Example
Example:500
Internal Server Error
Response Headers
ID uniquely identifying the request/response cycle.
Response Schema
RFC 9457 Problem Details for HTTP APIs. Provides a standardized format for conveying error details in HTTP responses.
object
URN-based error type identifiers following the pattern: urn:aerospike:errors:{category}:{specific}
Resource information (cluster, database, organization, etc.) is provided in the ProblemDetails context field, not in the URN.
A short, human-readable summary of the problem type
The HTTP status code
A human-readable explanation specific to this occurrence
A URI reference that identifies the specific occurrence
Context for resource-related errors (not-found, already-exists)
object
Type of resource (e.g., cluster, database, organization)
Identifier of the resource
Structured context for validation errors
object
JSON Pointer paths to missing required fields
Details about invalid field values
object
JSON Pointer path to the invalid field
URN identifying the specific validation error type
An optional human-readable description of the validation error
object
Developer-friendly message explaining the error. Deprecated: Use ‘detail’ field instead.