Replica Sets

Manage read replica sets and their associated actions.

Get Read Replica Sets

GET/projects/{project_id}/services/{service_id}/replicaSets

Create a Read Replica Set

POST/projects/{project_id}/services/{service_id}/replicaSets

Delete a Read Replica Set

DELETE/projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}

Resize a Read Replica Set

POST/projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/resize

Enable Connection Pooler for a Read Replica

POST/projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/enablePooler

Disable Connection Pooler for a Read Replica

POST/projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/disablePooler

Set Environment for a Read Replica

POST/projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/setEnvironment

ModelsExpand Collapse

ReadReplicaSet object { id, cpu_millis, memory_gbs, 6 more }

A set of read replicas for a service.

id: string

The unique identifier for the read replica set.

cpu_millis: number

CPU allocation in milli-cores.

memory_gbs: number

Memory allocation in gigabytes.

name: string

The name of the read replica set.

nodes: number

Number of nodes in the replica set.

status: "creating" or "active" or "resizing" or 2 more

The current status of the read replica set:

creating: the replica set is being provisioned
active: the replica set is provisioned and serving traffic
resizing: the replica set is being resized
deleting: the replica set is being deleted
error: the replica set is in an error state

One of the following:

"creating"

"active"

"resizing"

"deleting"

"error"

connection_pooler: optional ConnectionPooler { endpoint }

Connection pooler configuration for a service.

endpoint: optional Endpoint { host, port }

A network endpoint for connecting to a service.

host: optional string

The hostname of the endpoint.

port: optional number

The port of the endpoint.

endpoint: optional Endpoint { host, port }

A network endpoint for connecting to a service.

host: optional string

The hostname of the endpoint.

port: optional number

The port of the endpoint.

metadata: optional object { environment }

Additional metadata for the read replica set.

environment: optional string

Environment tag for the read replica set.

ReplicaSetRetrieveReplicaSetsResponse = array of ReadReplicaSet { id, cpu_millis, memory_gbs, 6 more }

id: string

The unique identifier for the read replica set.

cpu_millis: number

CPU allocation in milli-cores.

memory_gbs: number

Memory allocation in gigabytes.

name: string

The name of the read replica set.

nodes: number

Number of nodes in the replica set.

status: "creating" or "active" or "resizing" or 2 more

The current status of the read replica set:

creating: the replica set is being provisioned
active: the replica set is provisioned and serving traffic
resizing: the replica set is being resized
deleting: the replica set is being deleted
error: the replica set is in an error state

One of the following:

"creating"

"active"

"resizing"

"deleting"

"error"

connection_pooler: optional ConnectionPooler { endpoint }

Connection pooler configuration for a service.

endpoint: optional Endpoint { host, port }

A network endpoint for connecting to a service.

host: optional string

The hostname of the endpoint.

port: optional number

The port of the endpoint.

endpoint: optional Endpoint { host, port }

A network endpoint for connecting to a service.

host: optional string

The hostname of the endpoint.

port: optional number

The port of the endpoint.

metadata: optional object { environment }

Additional metadata for the read replica set.

environment: optional string

Environment tag for the read replica set.

ReplicaSetResizeResponse object { message }

message: optional string

ReplicaSetEnablePoolerResponse object { message }

message: optional string

ReplicaSetDisablePoolerResponse object { message }

message: optional string

ReplicaSetSetEnvironmentResponse object { message }

message: optional string