バックアップ構成設定の更新
- Cloud Managerへのプログラムによるアクセスのための OAuth 2.0認証はプレビュー機能として利用できます。
- 機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。 OAuth2.0 認証を使用するには、 Cloud Manager Public APIへのリクエストで使用する サービス アカウント を作成します。
必須のロール
このリソースには Project Automation Adminロールが必要です。
Resource
ベース URL: https://cloud.mongodb.com/api/public/v 1.0
PUT /groups/{PROJECT-ID}/automationConfig/backupAgentConfig
リクエスト
path パラメータ
名前 | タイプ | 必要性 | 説明 |
|---|---|---|---|
プロジェクトID | string | 必須 | 構成を所有する プロジェクト 24を識別する一意の 桁の 16 進数string 。 |
クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print にするかどうかを示すフラグ 形式。 |
| ||||||
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
ボディ パラメータ
Parameter | タイプ | 必要性 | 説明 | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
configオーバーライド | オブジェクト | 任意 | バックアップ設定がMongoDB Agentのバックアップ設定と異なるため、変更する必要がある MongoDB Agent 設定のリスト。 レガシーエージェントから MongoDB Agent にアップグレードする場合は、このオプションを構成します。
| ||||||||||||||||||||||||||||||||
logPath | string | 任意 | この MongoDB Agent がログを書き込む絶対ファイル パス。 これが指定されていない場合、ログは UNIX および Linux ベースのシステムでは標準エラー（ | ||||||||||||||||||||||||||||||||
logRotate | オブジェクト | 任意 | この MongoDB Agent がバックアップ ログをローテーションするしきい値。 | ||||||||||||||||||||||||||||||||
logRotate .sizeThresholdMB | integer | 任意 | この MongoDB Agent がログをローテーションするまでのログファイルの最大サイズ（MB 単位）。 | ||||||||||||||||||||||||||||||||
logRotate .timeDurationHrs | integer | 任意 | この MongoDB Agent がログファイルをローテーションする時間数。 | ||||||||||||||||||||||||||||||||
username | string | 任意 | バックアップ ログを管理するアプリケーション データベース内の MongoDB ユーザー。 APIを使用して MongoDB Agent の認証を有効にする場合は、このエンドポイントを実行するときに、このパラメータをmms-automationに設定します。 |
応答
Parameter | タイプ | 必要性 | 説明 | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
configオーバーライド | オブジェクト | 任意 | バックアップ設定がMongoDB Agentのバックアップ設定と異なるため、変更する必要がある MongoDB Agent 設定のリスト。 レガシーエージェントから MongoDB Agent にアップグレードする場合は、このオプションを構成します。
| ||||||||||||||||||||||||||||||||
logPath | string | 任意 | この MongoDB Agent がログを書き込む絶対ファイル パス。 これが指定されていない場合、ログは UNIX および Linux ベースのシステムでは標準エラー（ | ||||||||||||||||||||||||||||||||
logRotate | オブジェクト | 任意 | この MongoDB Agent がバックアップ ログをローテーションするしきい値。 | ||||||||||||||||||||||||||||||||
logRotate .sizeThresholdMB | integer | 任意 | この MongoDB Agent がログをローテーションするまでのログファイルの最大サイズ（MB 単位）。 | ||||||||||||||||||||||||||||||||
logRotate .timeDurationHrs | integer | 任意 | この MongoDB Agent がログファイルをローテーションする時間数。 | ||||||||||||||||||||||||||||||||
username | string | 任意 | バックアップ ログを管理するアプリケーション データベース内の MongoDB ユーザー。 APIを使用して MongoDB Agent の認証を有効にする場合は、このエンドポイントを実行するときに、このパラメータをmms-automationに設定します。 |
リクエストの例
curl --user "{publicApiKey}:{privateApiKey}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request PUT "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/automationConfig/backupAgentConfig?pretty=true" \ --data '{ "configOverrides" : { "mmsBaseUrl" : "http://new.example.org" }, "logPath": "/var/log/mongodb-mms-automation/backup-agent.log", "logRotate": { "sizeThresholdMB": 1000, "timeThresholdHrs": 12 }, "username": "mms-automation" }'
応答例
応答ヘッダー
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}
レスポンス本体
このエンドポイントは空のJSONオブジェクトを返します。