オートメーション構成の更新
- Cloud Managerへのプログラムによるアクセスのための OAuth 2.0認証はプレビュー機能として利用できます。
- 機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。 OAuth2.0 認証を使用するには、 Cloud Manager Public APIへのリクエストで使用する サービス アカウント を作成します。
プロジェクトの自動化構成を更新するには、 PUTを使用します。 PATCHは使用しないでください。
オートメーション構成を更新する方法のチュートリアルについては、「 オートメーション構成を更新する 」を参照してください。
hostname以外の MongoDB Agent を更新するには、別のエンドポイントを介して更新を行う必要があります。
更新を送信すると、Cloud Manager はデータを内部的に変更し、新しい構成バージョンを保存します。
例
Cloud Manager では、指定された各 MongoDB Community バージョンに フィールドが追加され、エージェントがそれらをダウンロードする場所を示す場合があります。
MongoDB エージェントは、構成の変更が発生していないか、Cloud Manager を継続的にポーリングし、変更が発生したときに構成の更新を取得します。 次に、エージェントはライブ プロセスの状態を一致するように調整します。
警告
Cloud Manager Administration API には、同時変更を防ぐための保護はありません。 2 人の管理者がそれぞれ現在のバージョンに基づく構成で開始し、独自の変更を加えてから変更を送信すると、後の変更が成功します。
警告
認証を有効にする前にエージェントユーザー名を更新
オートメーション構成は、 APIを使用してクラスターで認証を有効にする 唯一の 手段を提供します。 認証を有効にするには、まず"username": "mms-automation"を使用して次のエンドポイントを呼び出します。
必須のロール
このリソースにはProject Automation Adminロールが必要です。
Resource
ベース URL: https://cloud.mongodb.com/api/public/v 1.0
PUT /groups/{PROJECT-ID}/automationConfig
リクエスト
path パラメータ
名前 | タイプ | 必要性 | 説明 |
|---|---|---|---|
プロジェクトID | string | 必須 | オートメーション構成を所有するグループの一意の識別子。 |
クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print にするかどうかを示すフラグ 形式。 | false | ||||||
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
| false |
ボディ パラメータ
これらのパラメーターを確認するには、「オートメーション構成パラメーター 」を参照してください。
応答
これらのパラメーターを確認するには、「オートメーション構成パラメーター 」を参照してください。
リクエストの例
以下は、オートメーション構成を/Users/admin/updated-conf.jsonに保存されている更新された構成に置き換えます。 更新された構成ドキュメントの例については、「オートメーション構成の例 」を参照してください。
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request PUT "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/automationConfig?pretty=true" \ --data-binary "@/Users/admin/updated-conf.json"
応答例
応答ヘッダー
401 Unauthorized Content-Type: application/json;charset=ISO-8859-1 Date: {dateInUnixFormat} WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false Content-Length: {requestLengthInBytes} Connection: keep-alive
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}
レスポンス本体
この構成の例については、「オートメーション構成の例 」を参照してください。