This topic describes how to delete a replica of a specified tenant by using the API. The resource pool used by the replica will also be released. You can delete multiple replicas of a specified tenant at a time.
Call procedure
If a password is set, you must authenticate. For more information, see API hybrid encryption.
Request path
DELETE /api/v1/tenant/:name/replicas
Request parameters
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| zones | []string | Yes | ["zone1","zone2"] | The zones where the replicas to be deleted are located. |
Return result
| 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) taken by the server to process the request. |
| status | int | The HTTP status code. |
| traceId | string | The Trace ID of the request. |
| data | DagDetailDTO | Information about an asynchronous task. For more information, see the Data structure of DagDetailDTO section. |
| error | ApiError | The error generated by the request, which contains the following information:
|
The data structure of DagDetailDTO 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 execution operation of the DAG. |
| start_time | time.Time | The start time of the execution of the DAG. |
| end_time | time.Time | The end time of the execution of the DAG. |
| 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 details. |
Examples
Request example
DELETE 10.10.10.1:2886/api/v1/tenant/t1/replicas
{
"zones": [
"zone1"
]
}
Response example
{
"successful": true,
"timestamp": "2024-10-14T10:44:51.611972458+08:00",
"duration": 101,
"status": 200,
"traceId": "f80f9f2a1048b8e0",
"data": {
"id": "12",
"dag_id": 2,
"name": "Scale in tenant replicas",
"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 also call API methods by using SDKs.
For more information about how to call the API method by using obshell-sdk-python, see Delete a tenant replica.
For more information about how to call the API method by using obshell-sdk-go, see Delete a tenant replica.