This topic describes how to clear a specified tenant from the recycle bin by using the API. After a tenant is cleared from the recycle bin, the resource pool occupied by the tenant will be recycled.
Request parameters
Request path
DELETE /api/v1/resource-pool/:name
Response parameters
| Parameter | Type | Description |
|---|---|---|
| successful | bool | Indicates whether the request is successful. |
| timestamp | time.Time | The timestamp when the server completes the request. |
| duration | int | The time (in milliseconds) that the server takes to process the request. |
| status | int | The HTTP status code. |
| traceId | string | The Trace ID of the request. |
| data | DagDetailDTO | Information about the asynchronous task. For more information, see Data structure of the DagDetailDTO parameter. |
| error | ApiError | The error generated by the request. It contains the following information:
|
The data structure of the DagDetailDTO parameter is as follows:
| Parameter | Type | Description |
|---|---|---|
| id | string | The common ID of the DAG. |
| dag_id | int | The ID of the DAG, which is the primary key in OceanBase Database. |
| name | string | The name of the DAG. |
| stage | int | The current execution stage of the DAG. |
| max_stage | int | The total number of stages in the execution process of the DAG. |
| state | string | The execution status of the DAG. |
| operator | string | The type of the DAG execution operation. |
| start_time | time.Time | The start time of the DAG execution. |
| end_time | time.Time | The end time of the DAG execution. |
| additional_data | map[string]any | Other data of the DAG. |
| nodes | []NodeDetailDTO | Information about all nodes in the DAG. For more information, see Get node information. |
Examples
Request example
DELETE 10.10.10.1:2886/api/v1/resource-pool/t1
Response example
{
"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
}
}
References
You can call the API by using the CLI or SDK.
For more information about how to call the API by using obshell-sdk-python, see Clear a tenant from the recycle bin.
For more information about how to call the API by using obshell-sdk-go, see Clear a tenant from the recycle bin.