MongoDB Ops Manager インストールのグローバル アプリケーション設定を取得します。
必須のロール
このエンドポイントを正常に呼び出すには、 APIキーに Global Ownerロールが必要です。
リクエスト
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /admin/settings
リクエスト パス パラメーター
このエンドポイントは、HTTP リクエスト パス パラメーターを使用しません。
リクエスト クエリ パラメータ
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体をpretty-print形式にするかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
フィールド | タイプ | 説明 |
|---|---|---|
| オブジェクト | データベースに保存されているグローバルアプリ設定のキーと値のペア。MongoDB Ops Manager は、機密設定をプレーンテキストで返しません。 |
| オブジェクト | MongoDB Ops Manager にバンドルされているデフォルト構成ファイルからのキー値ペア。これらの設定は、インスタンスレベルの構成上書きファイルとは異なります。 |
| オブジェクト | インスタンスごとのデータベースの上書き設定。これらの設定は公開 API を使用して読み取ることはできますが、更新することはできません。 |
| オブジェクト | インスタンスレベルのデータベースオーバーライドに関連付けられたインスタンスの詳細。 |
| 文字列の配列 | MongoDB Ops Manager がデータベースに暗号化された値として保存する設定の名前。このリストの内容は、将来のリリースで変更される可能性があります。 |
リクエストの例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET \ "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/settings?pretty=true"
応答例
応答ヘッダー
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}
レスポンス本体
1 { 2 "dbProperties": { 3 "mms.centralUrl": "https://ops-manager.example.com", 4 "mms.https.CAFile": "/path/to/ca/file" 5 }, 6 "defaultFileProperties": { 7 "mms.https.ClientCertificateMode": "none" 8 }, 9 "instanceOverrides": { 10 "instance-1": { 11 "reCaptcha.enabled.registration": "false" 12 } 13 }, 14 "instanceDetails": { 15 "instance-1": { 16 "om.instance.runtime.availableProcessors": 2 17 } 18 }, 19 "secretProperties": [ 20 "mms.smtp.password" 21 ] 22 }