呼び出しの説明
インターフェース制約
obshell ServerはこのAPIに対してセキュリティ検証を実施します。詳細については、APIハイブリッド暗号化を参照してください。
リクエストパス
DELETE /api/v1/agent
POST /api/v1/agent/remove
リクエストパラメータ
| パラメータ | タイプ | 必須 | サンプル値 | 説明 |
|---|---|---|---|---|
| ip | string | はい | 10.10.10.1 | 削除するobshellのIPアドレス |
| port | int | はい | 2886 | 削除するobshellのポート |
実行結果
| パラメータ | タイプ | 説明 |
|---|---|---|
| successful | bool | リクエストが成功したかどうかを示します。 |
| timestamp | time.Time | サーバーがリクエストを完了したタイムスタンプです。 |
| duration | int | サーバーがリクエストを処理した時間（ミリ秒）です。 |
| status | int | HTTP Status規格に準拠したエンコードです。 |
| traceId | string | リクエストのトレースIDです。 |
| data | DagDetailDTO | 詳細については、以下のDagDetailDTO情報のデータ構造を参照してください。 |
| error | ApiError | リクエストによって生成されたエラーで、以下の情報が含まれます：
|
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内のすべてのノード情報。詳細については、ノードの詳細情報を取得するを参照してください。 |
例
リクエスト例
{
"ip":"10.10.10.1",
"port":2886
}
実行結果例
{
"successful": true,
"timestamp": "2024-01-09T11:53:04.340558805+08:00",
"duration": 1,
"status": 200,
"traceId": "1a4ef28ea713c837",
"data": {
"id": "22130706433028869",
"dag_id": 2,
"name": "Remove all agents",
"stage": 1,
"max_stage": 2,
"state": "READY",
"operator": "RUN",
"start_time": "2024-01-09T11:53:04.339374213+08:00",
"end_time": "2024-01-09T11:53:04.339374213+08:00",
"additional_data": null,
"nodes": null
}
}
関連ドキュメント
コマンドラインからAPIを呼び出す以外に、SDKメソッドを使用してAPIを呼び出すこともできます。
obshell-sdk-pythonを使用したAPIメソッドのリクエスト方法の詳細については、クラスタ初期化前にノードを削除するを参照してください。
obshell-sdk-goを使用したAPIメソッドのリクエスト方法の詳細については、クラスタ初期化前にノードを追加するを参照してください。