Managed Service for MySQL API, REST: Database.list
Retrieves the list of databases in a cluster.
HTTP request
GET https://mdb.api.cloud.yandex.net/managed-mysql/v1/clusters/{clusterId}/databases
Path parameters
Parameter | Description |
---|---|
clusterId | Required. ID of the cluster to list databases in. To get this ID, make 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 API returns a nextPageToken that can be used to get the next page of results in the subsequent list requests. Acceptable values are 0 to 1000, inclusive. |
pageToken | Page token that can be used to iterate through multiple pages of results. 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"
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
databases[] | object List of databases. |
databases[]. name |
string Name of the database. |
databases[]. clusterId |
string ID of the cluster that the database belongs to. |
nextPageToken | string The token that can be used to get the next page of results. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken in the subsequent list request to iterate through multiple pages of results. Each of the subsequent list requests should use the nextPageToken value returned by the previous request to continue paging through the results. |