Managed Service for PostgreSQL API, REST: Database.list
Retrieves the list of PostgreSQL Database resources in the specified cluster.
HTTP request
GET https://mdb.api.cloud.yandex.net/managed-postgresql/v1/clusters/{clusterId}/databases
Path parameters
Parameter | Description |
---|---|
clusterId | Required. ID of the PostgreSQL cluster to list databases in. To get the cluster ID use a list request. The maximum string length in characters is 50. |
Query parameters
Parameter | Description |
---|---|
pageSize | The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. The maximum value is 1000. |
pageToken | Page token. To get the next page of results, Set pageToken to the nextPageToken returned by the previous list request. The maximum string length in characters is 100. |
Response
HTTP Code: 200 - OK
{
"databases": [
{
"name": "string",
"clusterId": "string",
"owner": "string",
"lcCollate": "string",
"lcCtype": "string",
"extensions": [
{
"name": "string",
"version": "string"
}
],
"templateDb": "string",
"deletionProtection": true
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
databases[] | object List of PostgreSQL Database resources. |
databases[]. name |
string Name of the database. |
databases[]. clusterId |
string ID of the PostgreSQL cluster that the database belongs to. |
databases[]. owner |
string Name of the user assigned as the owner of the database. |
databases[]. lcCollate |
string POSIX locale for string sorting order. Can only be set at creation time. |
databases[]. lcCtype |
string POSIX locale for character classification. Can only be set at creation time. |
databases[]. extensions[] |
object PostgreSQL extensions enabled for the database. |
databases[]. extensions[]. name |
string Name of the extension, e.g. |
databases[]. extensions[]. version |
string Version of the extension. |
databases[]. templateDb |
string Name of the database template. |
databases[]. deletionProtection |
boolean (boolean) Deletion Protection inhibits deletion of the database Default value: |
nextPageToken | string This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results. |