AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。

公開APIを使用してプロセスを開始する

注意

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

このエンドポイントを使用して、以前に停止されたプロセスを開始します。Ops Manager は、自動化構成内のプロセスのdisabledをfalseに設定し、変更を公開します。

リクエストは非同期です。 200 OK Ops Manager が変更を公開したことを意味しますが、プロセスが実行されていることを意味するものではありません。プランが完了するまで自動化ステータスリソースをポーリングします。次に、 v 2.0 Get One Host by IDエンドポイント上のメンバーのreplicaStateNameがSECONDARYまたはPRIMARYに戻ることを確認します。

プロセスが既に実行中の場合、何も変更されず、エージェントは何もアクションを実行しませんが、Ops Manager は構成を公開し、イベントを記録します。プロセスが停止している間に oplog がローテーションした場合、メンバーはRECOVERINGままで、自動的に再同期されません。代わりに「プロセスの再同期」を使用してください。

ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

POST /groups/{GROUP-ID}/process/{HOST-PORT}:startup

このリクエストを行うAPIキーには、 Project Automation Adminロールが付与されている必要があります。

名前
タイプ
必要性
説明

グループ ID

string

必須

プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。

ホストする-ポート

string

必須

対象プロセスはhostname:portです。例えば、 node1.example.com:27017 。

名前
タイプ
必要性
説明
default

ryRun

ブール値

任意

trueの場合、Ops Manager はリクエストを検証し、変更されたプロセスを公開したりアクティビティ フィード イベントを追加したりせずに返します。Ops Manager はtrueまたはfalse以外の値を400 INVALID_QUERY_PARAMETERで拒否します。

false

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

名前
タイプ
必要性
説明
default

pretty

ブール値

任意

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

false

envelope

ブール値

任意

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

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

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

  • status: HTTPレスポンス コード

  • content: 期待される応答本体

false

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

Ops Manager は200 OKと、変更が適用された自動化構成に表示されるターゲットプロセスを返します。 disabledはfalseです。 dryRun設定するかどうかにかかわらず、本文は同じです。

名前
タイプ
説明

name

string

自動化設定におけるプロセス名。

Hostname

string

プロセスのホスト名。

プロセスタイプ

string

プロセスの種類、例: mongod 。

バージョン

string

MongoDB版のプロセス。

disabled

ブール値

true プロセスが停止された場合。

lastRestart

string

最後に再起動が要求された時刻のタイムスタンプ(ISO 8601 UTC形式)。

lastResync

string

最後に再同期が要求された時刻のタイムスタンプ(ISO 8601 UTC形式)。

このドキュメントには、 args2_6 、 featureCompatibilityVersion 、 authSchemaVersionなどのプロセスの自動化構成の残りの部分も含まれています。自動化構成のリファレンスを参照してください。

次の例では、 node1.example.com:27017上でプロセスを開始します。

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/process/node1.example.com:27017:startup?pretty=true"
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-alive
HTTP/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}
{ "name": "rs0_1", "processType": "mongod", "version": "8.0.4", "hostname": "node1.example.com", "disabled": false, "authSchemaVersion": 5, "featureCompatibilityVersion": "8.0", "args2_6": { "net": { "port": 27017 }, "replication": { "replSetName": "rs0" }, "storage": { "dbPath": "/data/rs0_1" }, "systemLog": { "destination": "file", "path": "/data/rs0_1/mongodb.log" } }}
HTTP Status
エラー コード
説明

200

--

変更が公開されたか、 dryRun=trueで計算されました。プロセス文書を返します。

400

--

プロセスが手動モードになっているか、自動化設定の検証に失敗しました。メッセージにその理由が示されています。ドライランでは返されません。

409

グループ復元モード

プロジェクトは復旧後、調整段階に入っています。

403

プロセス_外部管理

プロジェクトのプロセスは外部システムによって管理されています。

409

AUTOMATION_CONFIG_DRAFT_ALREADY_EXISTS

プロジェクト内に、未公開の自動化設定ドラフトが存在します。

404

プロセスが見つかりません

HOST-PORT プロジェクトの自動化設定にあるプロセスと一致しません。

400

無効なクエリパラメータ

dryRun trueでもfalseでもありません。

409

AUTOMATION_CONFIG_CONCURRENT_MODIFICATION

このリクエストの処理中に、誰かが変更を公開しました。Ops Manager は、実際のリクエストに対してのみこのコードを返します。

Ops Managerは、記載されている順序で共有エラーをチェックします。前提条件と制限事項については、 「プロセスライフサイクル」を参照してください。