Return Ranked Namespaces from a Cluster
On this page
Cloud Manager will no longer support Automation, Backup, and Monitoring for MongoDB 3.6 and 4.0 after August 30th, 2024. Please upgrade your MongoDB deployment or migrate to Atlas.
- OAuth 2.0 authentication for programmatic access to Cloud Manager is available as a Preview feature.
- The feature and the corresponding documentation might change at any time during the Preview period. To use OAuth 2.0 authentication, create a service account to use in your requests to the Cloud Manager Public API.
Return a subset of namespaces from the specified cluster sorted by the highest total execution time in descending order within the specified time window.
Base URL: https://cloud.mongodb.com/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/clusters/{hostClusterId}/{clusterView}/collStats/namespaces
Request Path Parameters
Parameter | Type | Description |
|---|---|---|
PROJECT-ID | string | (Required.) Unique 24-hexadecimal digit string that
identifies the project that contains the pinned namespaces. |
hostClusterId | string | (Required.) Unique identifier for the cluster that contains
the pinned namespaces. |
clusterView | string | (Required.) Name that identifies the cluster topology. Values include:
|
Request Query Parameters
All parameters are optional.
Name | Type | Description | Default |
|---|---|---|---|
pretty | boolean | Indicates whether the response body should be in a
prettyprint format. | false |
envelope | boolean | Indicates whether or not to wrap the response in an
envelope. | false |
period | string | Duration in ISO 8601 notation that specifies how far back in the past to
retrieve measurements. If you specify this value, you can't
specify For example, to request the last 36 hours, include this query
parameter: | |
start | string | Timestamp in ISO 8601 date and time format in UTC for the beginning of the period for which to
retrieve measurements. If you specify start you must also
specify end and you can't specify period. | |
end | string | Timestamp in ISO 8601 date and time format in UTC for the end of the period for which to retrieve
measurements. If you specify end you must also specify
start and you can't specify period. |
Request Body Parameters
This endpoint doesn't use HTTP request body parameters.
Response
Name | Type | Description |
|---|---|---|
groupId | string | Unique 24-hexadecimal digit string that identifies the project
that contains the namespaces. |
identifierId | string | Unique identifier of the cluster to which the
measurements pertain. |
rankedNamespaces | string | List that contains each namespace from the specified
cluster sorted by the highest total execution time in descending
order within the specified time window. |
Example Request
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --include \ --request GET 'https://{CLOUD-MANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{hostClusterId}/{clusterView}/collStats/namespaces?pretty=true&period={period}'
Example Response
Response Header
200 OK Vary: Accept-Encoding Content-Type: application/json Strict-Transport-Security: max-age=300 Date: {dateInUnixFormat} Connection: keep-alive Content-Length: {requestLengthInBytes} X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
Response Body
{ "groupId": "{PROJECT-ID}", "identifierId": "{hostClusterId}", "rankedNamespaces": [ "smol.dbA", "sample_mflix.movies", "sample_supplies.sales", "sample_mflix.theaters", "sample_guides.planets", "smol.dbD", "sample_restaurants.restaurants", "sample_mflix.embedded_movies", "sample_training.companies", "smol.floof", "sample_mflix.sessions", "smol.dbC", "sample_mflix.comments", "sample_training.trips", "sample_analytics.accounts", "sample_training.grades", "sample_airbnb.listingsAndReviews", "smol.dbB", "sample_training.posts", "sample_weatherdata.data" ] }