本記事では、APIを使用してごみ箱内の特定のテナントを削除する方法について説明します。指定したテナントを削除すると、そのテナントが占有していたリソースプールも回収されます。
呼び出しの説明
パスワードが設定されている場合は、認証を通過する必要があります。詳細については、APIハイブリッド暗号化を参照してください。
リクエストパス
DELETE /api/v1/resource-pool/:name
戻り値
パラメータ |
型 |
説明 |
|---|---|---|
| successful | bool | リクエストが成功したかどうかを示します。 |
| timestamp | time.Time | サーバーがリクエストを完了したタイムスタンプです。 |
| duration | int | サーバーがリクエストを処理する時間（ミリ秒）です。 |
| status | int | HTTPステータスコードに準拠したエンコードです。 |
| 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内のすべてのノード情報。ノードの詳細情報を取得するを参照してください。 |
例
リクエスト例
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メソッドのリクエスト方法については、ごみ箱からテナントの削除を参照してください。