Display information about a PostgreSQL cluster
Request
HTTP Method: POST
Content Type: application/json
Parameters
Property | Type | Description | Required |
|---|---|---|---|
| integer(int64) | configuration ID (non-negative) | required |
| string | cluster to display info for (primary or standby) (possible values: 'primary' and 'standby') | required |
| Code Block | ||
|---|---|---|
| ||
{
"params": {
"configuration_id": 1,
"role": "primary"
}
} |
Response
HTTP Status: 200
Content Type: application/json
Response
Property | Type | Description |
|---|---|---|
| object of type | error response |
| object of type | cluster-info/postgresql response |
| boolean | response with error or not |
cluster_info_postgresql_response
Property | Type | Description |
|---|---|---|
| string | name of cluster |
| string | directory for the cluster config files |
| string | directory for the cluster data files |
| array of database | databases in the cluster |
| string | host running cluster |
| integer | port number of cluster |
| string | cluster status (possible values: 'ONLINE', 'HOT STANDBY', 'WARM STANDBY', 'DOWN', 'ERROR' and 'NOT PRESENT') |
| array of tablespace | tablespaces in the cluster |
error_response
Property | Type | Description |
|---|---|---|
| string | error message |
database
Property | Type | Description |
|---|---|---|
| string | name of database |
| integer | size of database in bytes |
tablespace
Property | Type | Description |
|---|---|---|
| string | location of tablespace |
| string | name of tablespace |
| integer | size of tablespace in bytes |
| Code Block | ||
|---|---|---|
| ||
{
"error": {
"message": "string"
},
"result": {
"cluster_name": "string",
"config_directory": "string",
"data_directory": "string",
"databases": [
{
"name": "string",
"size": 123
}
],
"host": "string",
"port": 123,
"status": "ONLINE",
"tablespaces": [
{
"location": "string",
"name": "string",
"size": 123
}
]
},
"successful": true
} |
HTTP Status: 400
Content Type: application/json
Response
Property | Type | Description |
|---|---|---|
| object of type | error response |
| boolean | always false |
error_response
Property | Type | Description |
|---|---|---|
| string | error message |
| Code Block | ||
|---|---|---|
| ||
{
"error": {
"message": "string"
},
"successful": false
} |