エージェントのバージョンの更新
Cloud Manager は、 2024年8月30日でMongoDB 3.6と4.0のオートメーション、バックアップおよびモニタリングのサポートを終了します。 MongoDB の配置をアップグレードするか、Atlas に移行してください。
- Cloud Managerへのプログラムによるアクセスのための OAuth 2.0認証はプレビュー機能として利用できます。
- 機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。 OAuth2.0 認証を使用するには、 Cloud Manager Public APIへのリクエストで使用する サービス アカウント を作成します。
このエンドポイントは、MongoDB Agent とツールを、リクエストの時点で利用可能な最新バージョンに更新します。
このリクエストが完了すると、Cloud Manager はエージェント構成を変更し、更新されたバージョンを保存します。
必須のロール
このリソースには Project Automation Admin
ロールが必要です。
Resource
ベース URL: https://cloud.mongodb.com/api/public/v 1.0
POST /groups/{PROJECT-ID}/automationConfig/updateAgentVersions
リクエスト
path パラメータ
名前 | タイプ | 必要性 | 説明 |
---|---|---|---|
プロジェクトID | string | 必須 | オートメーション構成を所有するグループの一意の識別子。 |
クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default | ||||||
---|---|---|---|---|---|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print にするかどうかを示すフラグ 形式。 | false | ||||||
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
| false |
ボディ パラメータ
名前 | タイプ | 必要性 | 説明 |
---|---|---|---|
automationAgentVersion | string | 任意 | MongoDB Agent を更新するバージョン。 |
bioConnectorVersion | string | 任意 | BI Connectorを更新するバージョン。 |
mongoDbToolsVersion | string | 任意 | MongoDB Database Toolsを更新するバージョン |
応答
Parameter | タイプ | 説明 |
---|---|---|
automationAgentVersion | string | 指定されたプロジェクト内の MongoDB Agent のバージョン。 |
backupAgentVersion | string | 指定されたプロジェクト内のバックアップエージェントのバージョン。 Cloud Manager はバックアップエージェントを削除したため、このパラメータはnullを返す必要があります。 |
bioConnectorVersion | string | 指定されたプロジェクト内のMongoDB Connector for BIのバージョン。 |
mongoDbToolsVersion | string | 指定されたプロジェクト内の MongoDB Database Tools のバージョン。 |
monitoringAgentVersion | string | 指定されたプロジェクト内のモニタリングエージェントのバージョン。 Cloud Manager has removed the Monitoring Agent, so this parameter should return null. |
リクエストの例
1 curl --user "{publicApiKey}:{privateApiKey}" --digest \ 2 --header "Accept: application/json" \ 3 --header "Content-Type: application/json" \ 4 --include \ 5 --request POST "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/automationConfig/updateAgentVersions?pretty=true" \ 6 --data '{ 7 "automationAgentVersion": "11.11.0.7355" 8 }'
応答例
応答ヘッダー
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 "automationAgentVersion": "11.11.0.7355", 3 "backupAgentVersion" : null, 4 "biConnectorVersion" : "2.14.0", 5 "mongoDbToolsVersion" : null, 6 "monitoringAgentVersion" : null 7 }