Contact UsGet started

Managed Service for MongoDB API, gRPC: DatabaseService.List

Written by
Updated at November 26, 2024

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

gRPC request

rpc List (ListDatabasesRequest) returns (ListDatabasesResponse)

ListDatabasesRequest

{
  "cluster_id": "string",
  "page_size": "int64",
  "page_token": "string"
}

Field

Description

cluster_id

string

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

page_size

int64

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

page_token

string

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

ListDatabasesResponse

{
  "databases": [
    {
      "name": "string",
      "cluster_id": "string"
    }
  ],
  "next_page_token": "string"
}

Field

Description

databases[]

Database

List of MongoDB databases.

next_page_token

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListDatabasesRequest.page_size, use the next_page_token as the value
for the ListDatabasesRequest.page_token parameter in the next list request. Each subsequent
list request will have its own next_page_token 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.

cluster_id

string

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