/ /

グローバルアプリ設定の更新

MongoDB Ops Manager インストールのグローバルアプリケーション設定を更新します。変更する設定のみを含めます。MongoDB Ops Manager は、その他の設定を変更しません。

必須のロール

このエンドポイントを正常に呼び出すには、 APIキーに Global Ownerロールが必要です。

リクエスト

ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

PATCH /admin/settings

リクエストパスパラメーター

このエンドポイントは、HTTP リクエストパスパラメーターを使用しません。

リクエストクエリパラメータ

名前	タイプ	必要性	説明	default
pretty	ブール値	任意	レスポンス本体をpretty-print形式にするかどうかを示すフラグ。	`false`
envelope	ブール値	任意	応答をエンベロープでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリでenvelope=trueを設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。 `status`: HTTP レスポンスコード `content`: 期待される応答本体	`false`

リクエストボディパラメータ

フィールド	タイプ	必要性	説明
`dbProperties`	オブジェクト	必須	更新または追加するグローバルアプリ設定のキーと値のペア。リクエストに含まれていない設定は変更されません。設定を削除するには、その値を `null` に設定します。

重要

MongoDB Ops Manager は、値に関わらず mms.app.upgradeMode を含むすべてのリクエストを拒否します。これらのリクエストは、INVALID_SETTINGS_EXCEPTION エラーコードで 400 エラーを返します。

検証は、提出されたプロパティだけでなく、既存の設定と提出された設定のマージされたセットに対して実行されます。そのフィールドが提出した設定の依存関係であり、まだ構成されていない場合、リクエストは含まれていないフィールドで失敗する可能性があります。例えば、mms.mail.hostname に既存の値がない場合、{"mms.emailDaoClass": "SIMPLE_MAILER"} を提出すると detail: "mms.mail.hostname must not be blank" で失敗します。

応答

フィールド	タイプ	説明
`restartRequired`	ブール値	更新された設定を有効にするには、MongoDB Ops Managerを再起動する必要があるかどうかを示します。

リクエストの例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request PATCH \
     "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/settings?pretty=true" \
     --data '{
       "dbProperties": {
         "mms.centralUrl": "https://ops-manager.example.com"
       }
     }'

応答例

応答ヘッダー

HTTP/1.1 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

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

レスポンス本体

1 {
2   "restartRequired": false
3 }

戻る

設定を取得

バックアップ管理