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形式にするかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
フィールド | タイプ | 必要性 | 説明 |
|---|---|---|---|
| オブジェクト | 必須 | 更新または追加するグローバルアプリ設定のキーと値のペア。リクエストに含まれていない設定は変更されません。設定を削除するには、その値を |
重要
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" で失敗します。
応答
フィールド | タイプ | 説明 |
|---|---|---|
| ブール値 | 更新された設定を有効にするには、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 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}レスポンス本体
{ "restartRequired": false}