Return Pinned Namespaces
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 list of pinned namespaces for collection-level query latency metrics collection for the specified project and cluster.
Base URL: https://cloud.mongodb.com/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/clusters/{hostClusterId}/collStats/pinned
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. |
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 |
Request Body Parameters
This endpoint doesn't use HTTP request body parameters.
Response
Name | Type | Description |
|---|---|---|
clusterId | string | Unique string that identifies the cluster. |
groupId | string | Unique 24-hexadecimal digit string that
identifies the project. |
pinnedNamespaces | array | List that contains each pinned namespace. |
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}/collStats/pinned?pretty=true'
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
{ "clusterId": "{hostClusterId}", "groupId": "{PROJECT-ID}", "pinnedNamespaces": [ "testDb.collection1", "testDb.collection2" ] }