注意
グループとプロジェクトは同義語です。あなたの {PROJECT-ID} は、グループ IDと同じです。既存のグループの場合、グループ/グループ ID は同じままです。このページでは、説明を参照するときに、より一般的なタームのグループ を使用します。エンドポイントとなる接続されたデバイスは、ドキュメントに記載されているままです。
このエンドポイントを使用して、実行中のプロセスを正常に再起動します。Ops Manager は、自動化構成で該当プロセスにlastRestartを設定し、変更を公開します。プロセスが現在のプライマリである場合、自動化エージェントはプロセスを再起動する前に、そのプロセスを下位にステップダウンします。
リクエストは非同期です。 200 OK 、Ops Managerが変更を公開したことを意味しますが、プロセスが再起動したことを意味するものではありません。プランが完了するまで、自動化ステータスリソースをポーリングしてください。
再起動エンドポイントは、シャットダウンされたプロセスに対して400 PROCESS_DISABLED_CANNOT_RESTARTを返します。プロセスを開始するには、代わりに「プロセスの開始」を使用してください。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
POST /groups/{GROUP-ID}/process/{HOST-PORT}:restart必須のロール
このリクエストを行うAPIキーには、 Project Automation Adminロールが付与されている必要があります。
リクエスト パス パラメーター
名前 | タイプ | 必要性 | 説明 |
|---|---|---|---|
グループ ID | string | 必須 | プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。 |
ホストする-ポート | string | 必須 | 対象プロセスは |
リクエスト クエリ パラメータ
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
ryRun | ブール値 | 任意 |
|
|
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体をpretty-print形式にするかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
Ops Manager は200 OKと、変更が適用された状態で自動化構成に表示されるターゲットプロセスを返します。 lastRestartが設定されています。 dryRun設定するかどうかにかかわらず、本文は同じです。
名前 | タイプ | 説明 |
|---|---|---|
name | string | 自動化設定におけるプロセス名。 |
Hostname | string | プロセスのホスト名。 |
プロセスタイプ | string | プロセスの種類、例: |
バージョン | string | MongoDB版のプロセス。 |
disabled | ブール値 |
|
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:restart?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-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}レスポンス本体
{ "name": "rs0_1", "processType": "mongod", "version": "8.0.4", "hostname": "node1.example.com", "disabled": false, "lastRestart": "2026-10-06T09:15:20Z", "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 | -- | 変更が公開されたか、 |
400 | プロセスが無効になっているため、再起動できません。 | プロセスが停止しました。代わりに開始してください。 |
409 | プロセスエージェントが報告していません | 対象ホストのオートメーションエージェントは、Ops Managerに一度もレポートを送信していません。 |
409 | グループ復元モード | プロジェクトは復旧後、調整段階に入っています。 |
403 | プロセス_外部管理 | プロジェクトのプロセスは外部システムによって管理されています。 |
409 | AUTOMATION_CONFIG_DRAFT_ALREADY_EXISTS | プロジェクト内に、未公開の自動化設定ドラフトが存在します。 |
404 | プロセスが見つかりません |
|
400 | 無効なクエリパラメータ |
|
409 | AUTOMATION_CONFIG_CONCURRENT_MODIFICATION | このリクエストの処理中に、誰かが変更を公開しました。Ops Manager は、実際のリクエストに対してのみこのコードを返します。 |
Ops Managerは、記載されている順序で共有エラーをチェックします。前提条件と制限事項については、 「プロセスライフサイクル」を参照してください。