Docs Menu
Docs Home
/
MongoDB Ops Manager
/ / / /

モニタリング構成設定を取得する

項目一覧

  • 必須のロール
  • Resource
  • リクエスト
  • path パラメータ
  • クエリ パラメータ
  • ボディ パラメータ
  • 応答
  • リクエストの例
  • 応答例
  • 応答ヘッダー
  • レスポンス本体

このリソースには、 Project Automation Adminロールが必要です。

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

GET /groups/{PROJECT-ID}/automationConfig/monitoringAgentConfig
名前
タイプ
必要性
説明
プロジェクトID
string
必須
24string構成を所有する プロジェクト を識別する一意の 桁の 16 進数 。

次のクエリ パラメータは 任意です。

名前
タイプ
必要性
説明
default
pretty
ブール値
任意
false
envelope
ブール値
任意

応答をエンベロープでラップするかどうかを示すフラグ。

一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

名前
説明
状態
HTTPレスポンス コード
envelope
期待される応答本体
false

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

Parameter
タイプ
必要性
説明
configオーバーライド
オブジェクト
任意

モニタリング設定がMongoDB Agentのモニタリング設定と異なるため、変更する必要がある MongoDB Agent 設定のリスト。 レガシーエージェントから MongoDB Agent にアップグレードする場合は、このオプションを構成します。

logPath
string
任意
この MongoDB Agent がログを書き込む絶対ファイル パス。 これが指定されていない場合、ログは UNIX および Linux ベースのシステムでは標準エラー( stderr )に、Windows システムでは イベント ログ に書込みます。
logRotate
オブジェクト
任意
この MongoDB Agent が監視ログをローテーションするしきい値。
logRotate
.sizeThresholdMB
integer
任意
この MongoDB Agent がログをローテーションするまでのログファイルの最大サイズ(MB 単位)。
logRotate
.timeDurationHrs
integer
任意
この MongoDB Agent がログファイルをローテーションする時間数。
username
string
任意

モニタリング ログを管理するアプリケーション データベース内の MongoDB ユーザー。

APIを使用して MongoDB Agent の認証を有効にする場合は、このエンドポイントを実行するときに、このパラメータをmms-automationに設定します。

1curl --user "{publicApiKey}:{privateApiKey}" --digest \
2 --header "Accept: application/json" \
3 --include \
4 --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/automationConfig/monitoringAgentConfig?pretty=true" \
5 --output currentMonitoringConfig.json
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 "logPath": "/var/log/mongodb-mms-automation/monitoring-agent.log",
3 "logPathWindows": "%SystemDrive%\\MMSAutomation\\log\\mongodb-mms-automation\\monitoring-agent.log",
4 "logRotate": {
5 "sizeThresholdMB": 1000.0,
6 "timeThresholdHrs": 24
7 },
8 "username": "mms-automation"
9}

戻る

バックアップ構成設定の更新