This topic describes how to add a replica for a specified tenant by using the API. You can add multiple replicas for a specified tenant at a time.
Request parameters
| Parameter | Type | Required | Example value | Description |
|---|---|---|---|---|
| zone_list | []ZoneParam | Yes | See the Data structure of ZoneParam section below. | The resource specifications and distribution of the replicas to be added. |
The data structure of ZoneParam is as follows:
| Parameter | Type | Required | Example value | Description |
|---|---|---|---|---|
| name | string | Yes | zone1 | The name of the zone. |
| replica_type | string | No | FULL | The type of the tenant replica on the zone. Valid values include FULL (full-featured replica) and READONLY (read-only replica). The default value is FULL. |
| unit_config_name | string | Yes | s1 | The resource specifications of the tenant resource pool on the zone. |
| unit_num | int | Yes | 1 | The number of units of the tenant on the zone. |
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) 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 the asynchronous task. For more information, see the Data structure of DagDetailDTO section below. |
| error | ApiError | The error generated by the request. It 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
POST 10.10.10.1:2886/api/v1/tenant/t1/replicas
{
"zone_list": [
{
"name": "zone1",
"unit_config_name": "s1",
"unit_num": 1
}
]
}
Response example
{
"successful": true,
"timestamp": "2024-10-14T10:46:38.20335278+08:00",
"duration": 69,
"status": 200,
"traceId": "fbd20f5a7060af66",
"data": {
"id": "13",
"dag_id": 3,
"name": "Scale out 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 the API by using SDK methods.
For more information about how to call the API by using obshell-sdk-python, see Add a tenant replica.
For more information about how to call the API by using obshell-sdk-go, see Add a tenant replica.