プロジェクトのオートメーション構成によって、MongoDB プロセスとエージェントの最終状態が決まります。 MongoDB Agent は、指定された目的に従って配置を構築します。
オートメーション構成には、パスワードやキー値などの機密情報が含まれる場合があります。このリソースを使用すると、機密情報を含むフィールドを更新せずに、プロジェクトのオートメーション構成を更新できます。
PUT /groups/{PROJECT-ID}/automationConfig/noSecretsエンドポイントへの リクエストは、リクエスト本文内のオートメーション構成内の機密情報を含むフィールドを無視し、現在の値は変更されずに残り、他のすべてのフィールドを更新します。機密情報を含む完全なオートメーション構成を更新するには、 /groups/{PROJECT- ID}/automationConfig エンドポイントを使用します。
構成を更新するには:
現在の構成を取得します。
/groups/{PROJECT- ID}/automationConfig エンドポイントを使用して完全な構成を取得するか、 /groups/{PROJECT- ID}/automationConfig/noSecrets エンドポイントを使用して機密情報をリダクションされた構成を取得できます。パスワードやキー値など。
現在の構成のコピーを変更し、変更したいアイテムのみを変更します。
PUTPUTを使用して構成全体を置き換え、リクエスト本文に更新された構成を置き換えます。 を使用する必要があります。PATCHは使用しないでください。更新を送信すると、Cloud Manager はデータを内部的に変更し、新しい構成バージョンを保存します。
注意
一部のパラメータは、 automationConfigエンドポイントを介して更新できません。 詳しくは、以下を参照してください。
hostname以外の MongoDB Agent を更新するには、別のエンドポイントを介して更新を行う必要があります。
オートメーション構成を更新する方法のチュートリアルについては、「 オートメーション構成リソースの更新 」チュートリアルを参照してください。
MongoDB エージェントは、構成の変更が発生していないか、Cloud Manager を継続的にポーリングし、変更が発生したときに構成の更新を取得します。 次に、エージェントはライブ プロセスの状態を一致するように調整します。
警告
PUTリクエストを使用してオートメーション構成に変更を加えると、クラスターのダウンタイムが発生する可能性があります。変更を本番環境に適用する前に、下位環境で変更をテストしてください。
警告
Cloud Manager Administration API には、同時変更を防ぐための保護はありません。 2 人の管理者がそれぞれ現在のバージョンに基づく構成で開始し、独自の変更を加えてから変更を送信すると、後の変更が成功します。
警告
認証を有効にする前にエージェントユーザー名を更新
オートメーション構成は、 APIを使用してクラスターで認証を有効にする 唯一の 手段を提供します。 認証を有効にするには、まず"username": "mms-automation"を使用して次のエンドポイントを呼び出します。
必須のロール
このリソースにはProject Automation Adminロールが必要です。
Resource
ベース URL: https://cloud.mongodb.com/api/public/v1.0
PUT /groups/{PROJECT-ID}/automationConfig/noSecrets
リクエスト
path パラメータ
名前 | タイプ | 必要性 | 説明 |
|---|---|---|---|
プロジェクトID | string | 必須 | オートメーション構成を所有するグループの一意の識別子。 |
クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。 |
| ||||||
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
ボディ パラメータ
これらのパラメーターを確認するには、「オートメーション構成パラメーター 」を参照してください。
応答
これらのパラメーターを確認するには、「オートメーション構成パラメーター 」を参照してください。
リクエストの例
以下は、オートメーション構成を/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/noSecrets?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}
レスポンス本体
この構成の例については、「オートメーション構成の例 」を参照してください。