ピン留めされた名前空間を追加する

項目一覧

Resource

リクエストパスパラメーター
リクエストクエリパラメータ
リクエストボディパラメータ
応答
リクエストの例
応答例
応答ヘッダー
レスポンス本体

Cloud Manager は、 2024年8月30日でMongoDB 3.6と4.0のオートメーション、バックアップおよびモニタリングのサポートを終了します。 MongoDB の配置をアップグレードするか、Atlas に移行してください。

Cloud Managerへのプログラムによるアクセスのための OAuth 2.0認証はプレビュー機能として利用できます。: 機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。 OAuth2.0 認証を使用するには、 Cloud Manager Public APIへのリクエストで使用するサービスアカウントを作成します。

指定されたプロジェクトとクラスターのコレクションレベルのクエリレイテンシメトリクスを収集するために、既存の固定された名前空間リストに名前空間のリストを追加します。

ベース URL: https://cloud.mongodb.com/api/public/v 1.0

Resource

PATCH /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 PATCH 'https://{CLOUD-MANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{hostClusterId}/collStats/pinned?pretty=true'
 --data '{
     "namespaces": ["testDb.collection1", "testDb.collection2"]
   }'

応答例

応答ヘッダー

HTTP/1.1 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"
  ]
}

戻る

名前空間を固定する

ピンを返します