必須のロール
このリソースにはProject Automation Adminロールが必要です。
Resource
ベース URL: https://cloud.mongodb.com/api/public/v1.0
GET /groups/{PROJECT-ID}/automationConfig/monitoringAgentConfigリクエスト
path パラメータ
名前 | タイプ | 必要性 | 説明 |
|---|---|---|---|
プロジェクトID | string | 必須 | 構成を所有する プロジェクト 24を識別する一意の 桁の 16 進数string 。 |
クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体をpretty-print形式にするかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
Parameter | タイプ | 必要性 | 説明 |
|---|---|---|---|
configオーバーライド | オブジェクト | 任意 | モニタリング設定がMongoDB Agentのモニタリング設定と異なるため、変更する必要がある MongoDB Agent 設定のリスト。 レガシーエージェントから MongoDB Agent にアップグレードする場合は、このオプションを構成します。
|
logPath | string | 任意 | この MongoDB Agent がログを書き込む絶対ファイル パス。 これが指定されていない場合、ログは UNIX および Linux ベースのシステムでは標準エラー（ |
logRotate | オブジェクト | 任意 | この MongoDB Agent が監視ログをローテーションするしきい値。 |
logRotate | integer | 任意 | この MongoDB Agent がログをローテーションするまでのログファイルの最大サイズ（MB 単位）。 |
logRotate | integer | 任意 | この MongoDB Agent がログファイルをローテーションする時間数。 |
username | string | 任意 | モニタリング ログを管理するアプリケーション データベース内の MongoDB ユーザー。 APIを使用して MongoDB Agent の認証を有効にする場合は、このエンドポイントを実行するときに、このパラメータをmms-automationに設定します。 |
リクエストの例
curl --user "{publicApiKey}:{privateApiKey}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/automationConfig/monitoringAgentConfig?pretty=true" \ --output currentMonitoringConfig.json応答例
応答ヘッダー
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}レスポンス本体
{ "logPath": "/var/log/mongodb-mms-automation/monitoring-agent.log", "logPathWindows": "%SystemDrive%\\MMSAutomation\\log\\mongodb-mms-automation\\monitoring-agent.log", "logRotate": { "sizeThresholdMB": 1000.0, "timeThresholdHrs": 24 }, "username": "mms-automation"}