最新のプランのオートメーションステータスを取得する

項目一覧

Overview

Resource
Request Parameters
リクエストパスパラメーター
リクエストクエリパラメータ
リクエストボディパラメータ
応答
リクエストの例
応答例

Cloud Manager は、 2024年8月30日でMongoDB 3.6と4.0のオートメーション、バックアップおよびモニタリングのサポートを終了します。 MongoDB の配置をアップグレードするか、Atlas に移行してください。

Cloud Managerへのプログラムによるアクセスのための OAuth 2.0認証はプレビュー機能として利用できます。: 機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。 OAuth2.0 認証を使用するには、 Cloud Manager Public APIへのリクエストで使用するサービスアカウントを作成します。

注意

グループとプロジェクトは同義語です。あなたの {PROJECT-ID}はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。このページでは、説明を参照するときに、より一般的な用語のグループを使用します。エンドポイントはドキュメントに記載されているままです。

Overview

MongoDB プロセスの最新のプランを取得します。プランは、MongoDB をgoalVersionに配置するために必要なアクションのセットです。

エンドポイントは、オートメーション構成の現在のバージョンを報告するためのgoalVersionフィールドと、各サーバーで実行されている構成のバージョンを報告するためのlastGoalVersionAchievedフィールドを返します。

ベース URL: https://cloud.mongodb.com/api/public/v 1.0

Resource

GET /groups/{PROJECT-ID}/automationStatus

Request Parameters

リクエストパスパラメーター

Parameter	タイプ	説明
プロジェクトID	string	（必須。）プロジェクトの一意の識別子。

リクエストクエリパラメータ

次のクエリパラメータは任意です。

名前

タイプ

必要性

説明

default

pretty

ブール値

任意

レスポンス本体を pretty-print にするかどうかを示すフラグ形式。

false

envelope

ブール値

任意

応答をエンベロープでラップするかどうかを示すフラグ。

一部の APIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリでenvelope=trueを設定します。

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

名前	説明
`status`	HTTPレスポンスコード
`content`	期待される応答本体

false

リクエストボディパラメータ

このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。

応答

名前	タイプ	説明
targetVersion	数値	最後に送信されたオートメーション構成のバージョン。自動化構成の送信が競合した場合、このフィールドには勝者となる構成がリストされます。
プロセス	配列	プロジェクトに配置された MongoDB インスタンス。
Process.errorCode	integer	エラーコード。プロセスにエラーがない場合は`0`を返します。
Process.errorCode の説明	string	詳細なエラーの説明。プロセスにエラーがない場合は、空の string を返します。
process.errorCode人間読み取り可能	string	短いエラーの説明。プロセスにエラーがない場合は、空の string を返します。
process.errorString	string	エラーを含むログ行の出力。追加のエラーコンテキストについては、このフィールドを調べてください。プロセスにエラーがない場合は、空の string を返します。
operations.hostname	string	MongoDB プロセスとオートメーションがホストされているサーバーの完全修飾ドメイン名（ `hostname -f`の発行によって取得されます）。
operations.name	string	オートメーション構成で指定されたプロセス名。
process.lastGoalVersionApied	数値	このプロセスが構成されたとおりに配置されたオートメーション構成の最後のバージョン。 `processes.lastGoalVersionAchieved`数値が`goalVersion`数値と等しくない場合、現在の構成ではプロセスはまだ配置されていません。
operations.plan	配列	構成がまだ最新ではないプロセスが目的の状態に達する方法を説明します。

リクエストの例

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --header 'Accept: application/json' \
     --include \
     --request GET -i "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/automationStatus"

応答例

応答ヘッダー

HTTP/1.1 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

HTTP/1.1 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}

レスポンス本体

{
     "goalVersion": 11,
     "processes": [{
             "errorCode": 0,
             "errorCodeDescription": "",
             "errorCodeHumanReadable": "",
             "errorString": "",
             "hostname": "example.net",
             "lastGoalVersionAchieved": 11,
             "name": "myReplicaSet_3",
             "plan": ["Download",
                     "WaitRsInit",
                     "WaitFeatureCompatibilityVersionCorrect"
             ]
     }, {
             "errorCode": 100,
             "errorCodeDescription": "There is an issue with file permissions for this process",
             "errorCodeHumanReadable": "File Permissions Error",
             "errorString": "<myReplicaSet_1> [13:11:33.348] Failed to compute states : <myReplicaSet_1> [13:11:33.348] Error calling ComputeState : <myReplicaSet_1> [13:11:33.348] Error getting fickle state for current state : <myReplicaSet_1> [13:11:33.348] Error checking if process is running from dbpath = /data/0 : <myReplicaSet_1> [13:11:33.348] Error getting file contents of /data/0/mongod.lock as string : <myReplicaSet_1> [13:11:33.348] Error reading file from /data/0/mongod.lock : open /data/0/mongod.lock: permission denied",
             "hostname": "example.net",
             "lastGoalVersionAchieved": 1,
             "name": "myReplicaSet_1",
             "plan": ["Download"]
     }, {
             "errorCode": 0,
             "errorCodeDescription": "",
             "errorCodeHumanReadable": "",
             "errorString": "",
             "hostname": "example.net",
             "lastGoalVersionAchieved": 11,
             "name": "myReplicaSet_2",
             "plan": ["WaitRsInit",
                     "WaitFeatureCompatibilityVersionCorrect"
             ]
     }]
}

戻る

モニタリング構成設定の更新

過去 50 件のプランのオートメーションステータスを取得する

注意