Contact UsGet started

Managed Service for MongoDB API, gRPC: DatabaseService.List

Written by
Updated at October 17, 2024

Retrieves the list of MongoDB Database resources in the specified cluster.

gRPC request

rpc List (ListDatabasesRequest) returns (ListDatabasesResponse)

ListDatabasesRequest

{
  "clusterId": "string",
  "pageSize": "int64",
  "pageToken": "string"
}

Field

Description

clusterId

string

Required field. ID of the MongoDB cluster to list databases in.
To get the cluster ID, use a ClusterService.List request.

pageSize

int64

The maximum number of results per page to return. If the number of available
results is larger than pageSize, the service returns a ListDatabasesResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.

pageToken

string

Page token. To get the next page of results, set pageToken to the
ListDatabasesResponse.nextPageToken returned by the previous list request.

ListDatabasesResponse

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

Field

Description

databases[]

Database

List of MongoDB databases.

nextPageToken

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListDatabasesRequest.pageSize, use the nextPageToken as the value
for the ListDatabasesRequest.pageToken parameter in the next list request. Each subsequent
list request will have its own nextPageToken to continue paging through the results.

Database

A MongoDB Database resource. For more information, see the
Developer's Guide.

Field

Description

name

string

Name of the database.

clusterId

string

ID of the MongoDB cluster that the database belongs to.
Previous
Get
Next
Create