このエンドポイントは、MongoDB Agent とツールを、リクエストの時点で利用可能な最新バージョンに更新します。
このリクエストが完了すると、Cloud Manager はエージェント構成を変更し、更新されたバージョンを保存します。
必須のロール
このリソースにはProject Automation Adminロールが必要です。
Resource
ベース URL: https://cloud.mongodb.com/api/public/v1.0
POST /groups/{PROJECT-ID}/automationConfig/updateAgentVersionsリクエスト
path パラメータ
名前 | タイプ | 必要性 | 説明 |
|---|---|---|---|
プロジェクトID | string | 必須 | オートメーション構成を所有するグループの一意の識別子。 |
クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体をpretty-print形式にするかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
ボディ パラメータ
名前 | タイプ | 必要性 | 説明 |
|---|---|---|---|
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. |
リクエストの例
curl --user "{publicApiKey}:{privateApiKey}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/automationConfig/updateAgentVersions?pretty=true" \ --data '{ "automationAgentVersion": "11.11.0.7355" }'応答例
応答ヘッダー
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}レスポンス本体
{ "automationAgentVersion": "11.11.0.7355", "backupAgentVersion" : null, "biConnectorVersion" : "2.14.0", "mongoDbToolsVersion" : null, "monitoringAgentVersion" : null}