Method list

Статья создана

Retrieves the list of SQL Server databases in the specified cluster.

HTTP request

GET https://mdb.api.cloud.yandex.net/mdb/sqlserver/v1/clusters/{clusterId}/databases

Parameter	Description
clusterId	Required. ID of the SQL Server cluster to list databases in. To get the cluster ID, use a list request. The maximum string length in characters is 50.

Parameter	Description
pageSize	The maximum number of results per page to return. If the number of available results is larger than `page_size`, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive.
pageToken	Page token. To get the next page of results, Set `page_token` to the nextPageToken returned by a previous list request. The maximum string length in characters is 100.

HTTP Code: 200 - OK

{
  "databases": [
    {
      "name": "string",
      "clusterId": "string"
    }
  ],
  "nextPageToken": "string"
}

Field	Description
databases[]	object An SQL Server database. For more information, see the Concepts section of the documentation.
databases[]. name	string Name of the database.
databases[]. clusterId	string ID of the SQL Server cluster the database belongs to.
nextPageToken	string Token that allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the `next_page_token` as the value for the pageToken parameter in the next list request. Each subsequent list request will have its own `next_page_token` to continue paging through the results.