システムログのローテーション設定の更新
このエンドポイントは、 MongoDB Agent システムのログローテーション構成を更新します。 このリクエストが完了すると、 MongoDB Ops Managerはエージェント構成を変更し、更新されたバージョンを保存します。
必須のロール
このリソースには、 Project Automation Admin
ロールが必要です。
Resource
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
PUT /groups/{PROJECT-ID}/automationConfig/systemLogRotateConfig
リクエスト
path パラメータ
名前 | タイプ | 必要性 | 説明 |
---|---|---|---|
プロジェクトID | string | 必須 | オートメーション構成を所有するプロジェクトの一意の識別子。 |
クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default | ||||||
---|---|---|---|---|---|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print にするかどうかを示すフラグ 形式。 |
| ||||||
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
ボディ パラメータ
注意
空のリクエスト本体を渡すと、MongoDB Ops Manager はログローテーションを無効にします。 入力済みリクエストビルドには少なくともsizeThresholdMB
timeThresholdHrs
フィールドと フィールドが必要です。MongoDB Ops Manager は、その他の null または入力されていないリクエストのボディフィールドを、システムのデフォルトの に設定します。
名前 | タイプ | 必要性 | 説明 |
---|---|---|---|
sizeThresholdMB | float | 任意 | ローテーション前の個々のログファイルの最大サイズ(MB 単位)。 注:ログローテーションを無効にするために空のリクエスト本文を渡す場合を除き、このパラメーターは必須です。 |
timeThresholdHrs | 整数 | 任意 | ローテーション前の個々のログファイルの最大時間(時間単位)。 注:ログローテーションを無効にするために空のリクエスト本文を渡す場合を除き、このパラメーターは必須です。 |
numUncompressed | 整数 | 任意 | 現在のログファイルを含む、非圧縮のままにするログファイルの最大合計数。 デフォルトは |
percentOfDiskspace | float | 任意 | 削除前に、すべてのログファイルが消費するディスク領域の最大パーセンテージ。 デフォルトは |
numTotal | 整数 | 任意 | ログファイルの合計数。 ディスク上のログファイルの数がこの数を超えると、最も古いファイルが削除されます。 数値が指定されていない場合、デフォルトは0になり、他の設定によって決まります。 |
応答
MongoDB Ops Manager は、リクエストが成功したイベント、空のJSONオブジェクトを返します。
リクエストの例
1 curl --user "{publicApiKey}:{privateApiKey}" --digest \ 2 --header "Accept: application/json" \ 3 --header "Content-Type: application/json" \ 4 --include \ 5 --request PUT "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/automationConfig/systemLogRotateConfig?pretty=true" \ 6 --data ' { 7 "sizeThresholdMB": 5005.5, 8 "timeThresholdHrs": 13, 9 "numUncompressed": 10, 10 "percentOfDiskspace": 0.1, 11 "numTotal": 15 12 }'
応答例
応答ヘッダー
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}
レスポンス本体
{ }