クラスターからランク付けされた名前空間を返す
- Cloud Managerへのプログラムによるアクセスのための OAuth 2.0認証はプレビュー機能として利用できます。
- 機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。 OAuth2.0 認証を使用するには、 Cloud Manager Public APIへのリクエストで使用する サービス アカウント を作成します。
指定されたクラスターから名前空間のサブセットを、指定された時間枠内の合計実行時間の最も長い順で降順にソートして返します。
ベース URL: https://cloud.mongodb.com/api/public/v 1.0
Resource
GET /groups/{PROJECT-ID}/clusters/{hostClusterId}/{clusterView}/collStats/namespaces
リクエスト パス パラメーター
Parameter | タイプ | 説明 |
---|---|---|
プロジェクトID | string | (必須。) 固定された名前空間を含むプロジェクトを識別する一意の 24 桁の 16 進数string 。 |
hostClusterId | string | (必須。) 固定された名前空間を含むクラスターの一意の識別子。 |
clusterView | string | (必須。) クラスター トポロジーを識別する名前。 値には、次のものが含まれます。
|
リクエスト クエリ パラメータ
すべてのパラメーターは任意です。
名前 | タイプ | 説明 | default |
---|---|---|---|
pretty | ブール値 | レスポンス本体を pretty-print にするかどうかを示します 形式。 |
|
envelope | ブール値 | 応答をエンベロープでラップするかどうかを示します。 |
|
period | string | ISO8601 の期間 過去の測定値を検索する方法を指定する表記。この値を指定した場合、 たとえば、過去の36時間をリクエストするには、次のクエリ パラメータを含めます: | |
始める | string | ISO8601 のタイムスタンプ 測定値を取得する期間の開始の日付と時刻形式( UTC) 。 | |
end | string | ISO8601 のタイムスタンプ 測定値を取得する期間の終了の日付と時刻( UTC) 形式。 |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
名前 | タイプ | 説明 |
---|---|---|
グループ ID | string | 名前空間を含むプロジェクトを識別する一意の 24 桁の 16 進数string 。 |
identityId | string | 測定値が含まれるクラスターの一意の識別子。 |
rankNamespaces | string | 指定されたクラスターの各名前空間を含むリストが、指定された時間枠内の合計実行時間の最も長い順で降順にソートされます。 |
リクエストの例
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}'
応答例
応答ヘッダー
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}
レスポンス本体
{ "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" ] }