Retrieve an Existing Read-only Replica

v1.0.0

To show information about an existing database replica, send a GET request to /v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME.

Note: Read-only replicas are not supported for Redis clusters.

The response will be a JSON object with a replica key. This will be set to an object containing the standard database replica attributes.

Input

{
  "type": "object",
  "properties": {
    "database_cluster_uuid": {
      "type": "string",
      "format": "uuid"
    },
    "replica_name": {
      "type": "string"
    }
  },
  "required": [
    "database_cluster_uuid",
    "replica_name"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "replica": {
      "type": "object",
      "required": [
        "name"
      ],
      "properties": {
        "connection": {
          "type": "object"
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "description": "A time value given in ISO8601 combined date and time format that represents when the database cluster was created."
        },
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "A unique ID that can be used to identify and reference a database replica."
        },
        "name": {
          "type": "string",
          "description": "The name to give the read-only replicating"
        },
        "private_connection": {
          "type": "object"
        },
        "private_network_uuid": {
          "type": "string",
          "description": "A string specifying the UUID of the VPC to which the read-only replica will be assigned. If excluded, the replica will be assigned to your account's default VPC for the region."
        },
        "region": {
          "type": "string",
          "description": "A slug identifier for the region where the read-only replica will be located. If excluded, the replica will be placed in the same region as the cluster."
        },
        "size": {
          "type": "string",
          "description": "A slug identifier representing the size of the node for the read-only replica. The size of the replica must be at least as large as the node size for the database cluster from which it is replicating."
        },
        "status": {
          "type": "string",
          "description": "A string representing the current status of the database cluster.",
          "enum": [
            "creating",
            "online",
            "resizing",
            "migrating",
            "forking"
          ]
        },
        "tags": {
          "type": "array",
          "description": "A flat array of tag names as strings to apply to the read-only replica after it is created. Tag names can either be existing or new tags.",
          "items": {
            "type": "string"
          }
        }
      }
    }
  }
}