名前空間を固定する
指定されたプロジェクトとクラスターのコレクションレベルのクエリレイテンシメトリクスコレクション用に名前空間のリストを固定します。 このアクションは、プロジェクトまたはクラスターに対して、固定された名前空間リストを初期化するか、既存の固定された名前空間リストを置き換えます。
ベース URL: https://cloud.mongodb.com/api/public/v 1.0
Resource
PUT /groups/{PROJECT-ID}/clusters/{hostClusterId}/collStats/pinned
リクエスト パス パラメーター
Parameter | タイプ | 説明 |
|---|---|---|
プロジェクトID | string | （必須。） 固定する名前空間を含むプロジェクトを識別する一意の 24 桁の 16 進数string 。 |
hostClusterId | string | （必須。） 固定する名前空間を含むクラスターの一意の識別子。 |
リクエスト クエリ パラメータ
すべてのパラメーターは任意です。
名前 | タイプ | 説明 | default |
|---|---|---|---|
pretty | ブール値 | レスポンス本体を pretty-print にするかどうかを示します 形式。 | false |
envelope | ブール値 | 応答をエンベロープでラップするかどうかを示します。 | false |
リクエスト ボディ パラメータ
名前 | タイプ | 説明 | default |
|---|---|---|---|
名前空間 | 配列 | クエリ レイテンシ メトリクス コレクション用に固定する各名前空間を含むリスト。 |
応答
名前 | タイプ | 説明 |
|---|---|---|
clusterId | string | クラスターを識別する一意のstring 。 |
グループ ID | string | プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。 |
completedNamespaces | 配列 | アップデートの完了後に、固定された各名前空間を含むリスト。 |
リクエストの例
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --include \ --request PUT 'https://{CLOUD-MANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{hostClusterId}/collStats/pinned?pretty=true' --data '{ "namespaces": ["testDb.collection1", "testDb.collection2"] }'
応答例
応答ヘッダー
201 Created 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}
レスポンス本体
{ "clusterId": "{hostClusterId}", "groupId": "{PROJECT-ID}", "pinnedNamespaces": [ "testDb.collection1", "testDb.collection2" ] }