このドキュメントでは、クラスタ内の指定されたノードを停止する方法について説明します。
呼び出しの概要
インターフェース制約
obshell ServerはこのAPIに対してセキュリティ検証を実施します。詳細については API混合暗号化を参照してください。
リクエストパス
POST /api/v1/ob/stop
リクエストパラメータ
パラメータ |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| scope | Scope | はい | { "type": "GLOBAL" } |
アプリケーションがこの設定を適用するOBServerノードの範囲を設定します。詳細については、以下の Scope情報のデータ構造 を参照してください。 |
| force | bool | いいえ | true | trueの場合、observerプロセスを強制終了します。 |
| forcePassDag | []string | いいえ | なし | 前提となる起動/停止タスクのIDを指定します。特別な状況下でのみ使用します(クラスタの運用が1つまたは複数の前提運用作業タスクによってロックされている場合、このパラメータを使用して前提タスクをロック解除できます)。 |
Scope情報のデータ構造:
パラメータ |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| type | string | はい | "GLOBAL" | 設定の有効レベルを設定します。取り得る値は GLOBAL、ZONE、SERVER です。 |
| target | []string | いいえ | サンプル値：["10.10.10.1:2886", "10.10.10.2:2886"] または ["zone1","zone2"] | type が SERVER の場合、OBServerノードのリストを設定します。type が ZONE の場合、Zoneのリストを設定します。type が GLOBAL の場合、設定は不要です。 |
戻り値
パラメータ |
型 |
説明 |
|---|---|---|
| successful | bool | リクエストが成功したかどうか。 |
| timestamp | time.Time | サーバーがリクエストを完了したタイムスタンプ。 |
| duration | int | サーバーがリクエストを処理した時間(ミリ秒)。 |
| status | int | HTTP Status仕様に準拠したエンコード。 |
| traceId | string | リクエストのTrace ID。 |
| data | DagDetailDTO | 詳細については、以下の DagDetailDTO情報のデータ構造 を参照してください。 |
| error | ApiError | リクエストによって生成されたErrorで、以下の情報を含みます：
|
DagDetailDTO情報のデータ構造は以下のとおりです：
パラメータ |
型 |
説明 |
|---|---|---|
| id | string | DAG共通ID。 |
| dag_id | int | DAG ID。OceanBaseデータベースに登録されている主キーです。 |
| name | string | DAG名。 |
| stage | int | DAGの現在の実行段階。 |
| max_stage | int | DAG実行プロセス中の段階総数。 |
| state | string | DAGの実行状態。 |
| operator | string | DAGの実行操作タイプ。 |
| start_time | time.Time | DAG実行開始時間。 |
| end_time | time.Time | DAG実行終了時間。 |
| additional_data | map[string]any | DAGのその他のデータ。 |
| nodes | []NodeDetailDTO | DAG内のすべてのノード情報。詳細はノードの詳細情報を取得するを参照してください。 |
例
リクエスト例
POST 10.10.10.1:2886/api/v1/ob/stop
{
"scope": {
"type": "GLOBAL"
},
"force": true
}
レスポンス例
{
"successful": true,
"timestamp": "2024-01-10T11:24:21.274727587+08:00",
"duration": 3,
"status": 200,
"traceId": "d0991236cc3983cf",
"data": {
"id": "22130706433028869",
"dag_id": 11,
"name": "Stop OB",
"stage": 1,
"max_stage": 5,
"state": "READY",
"operator": "RUN",
"start_time": "2024-01-10T11:24:21.272439704+08:00",
"end_time": "2024-01-10T11:24:21.272439704+08:00",
"additional_data": null,
"nodes": null
}
}
関連ドキュメント
コマンドラインでAPIを呼び出すほかに、SDKメソッドを使用してAPIを呼び出すこともできます。