本記事では、APIを使用してごみ箱内の指定されたテナントを削除する方法について説明します。指定されたテナントが削除されると、そのテナントが占有していたリソースプールも回収されます。
呼び出しの説明
パスワードが設定されている場合は、認証を通過する必要があります。詳細については、APIハイブリッド暗号化を参照してください。
リクエストパス
DELETE /api/v1/resource-pool/:name
実行結果
| パラメータ | タイプ | 説明 |
|---|---|---|
| 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内のすべてのノード情報。詳細はNodeの詳細情報を取得するを参照してください。 |
例
リクエスト例
DELETE 10.10.10.1:2886/api/v1/resource-pool/t1
実行結果例
{
"successful": true,
"timestamp": "2024-10-14T16:06:06.123724431+08:00",
"duration": 92,
"status": 200,
"traceId": "7790b10d488d0d39",
"data": {
"id": "19",
"dag_id": 9,
"name": "Wait tenant purge finished",
"stage": 1,
"max_stage": 2,
"state": "READY",
"operator": "RUN",
"start_time": "0001-01-01T00:00:00Z",
"end_time": "0001-01-01T00:00:00Z",
"additional_data": null,
"nodes": null
}
}
関連ドキュメント
コマンドラインでAPIを呼び出す以外に、SDKメソッドを使用してAPIを呼び出すこともできます。
obshell-sdk-pythonを使用したAPIメソッドのリクエスト方法の詳細については、ごみ箱からテナントを削除するを参照してください。
obshell-sdk-goを使用したAPIメソッドのリクエスト方法の詳細については、ごみ箱からテナントを削除するを参照してください。