Feature description
The interface is used to modify a replica of a specified tenant.
Call instructions
Interface constraints
You must use OCP application service authentication.
Request path
POST /api/v2/ob/clusters/{id}/tenants/{tenantId}/modifyReplica
Request parameters
path:
Parameter |
Type |
Required |
Example value |
Description |
|---|---|---|---|---|
| id | Long | Yes | 20 | The cluster ID of the target tenant in OCP. |
| tenantId | Long | Yes | 3 | The tenant ID of the target tenant in OCP. |
body:
Parameter |
Type |
Required |
Example value |
Description |
|---|---|---|---|---|
| zoneName | String | Yes | foo | The tenant name, which is unique in the cluster. |
| replicaType | String | No | FULL | The replica type. Valid values: |
| resourcePool | Object | No | -- | The resource pool information. |
| ├─unitSpecName | Object | No | S1 | The unit specification name. You can view the specification list on the “Unit Specification Management” page. |
| ├─unitCount | Integer | No | 1 | The number of units. |
Return results
Basic data structure
Parameter |
Type |
Description |
|---|---|---|
| data | Object | The information about the created tenant and the asynchronous DAG task. For more information, see Task information. |
| successful | Boolean | Indicates whether the request is successful. |
| timestamp | Datetime | The timestamp when the server finishes processing the request. |
| duration | Integer | The time taken by the server to process the request, in milliseconds. |
| status | Integer | The HTTP status code that conforms to the HTTP status code specification. |
| traceId | String | The Trace ID of the request, which is used for troubleshooting. |
| server | String | The address of the application service that responds to the request. |
Example
Request example
POST /api/v2/ob/clusters/20/tenants/3/modifyReplica
[
{
"zoneName": "zone1",
"replicaType": "FULL",
"resourcePool": {
"unitSpecName": "S1",
"unitCount": 1
}
}
]
Response example
{
"data": {
"cluster": {
"id": 20,
"name": "ob_upgrade",
"obClusterId": 20
},
"context": "Context(parallelIdx=-1, stringMap={tenant_id=3, cluster_id=20, zone_name=zone2}, listMap={})",
"creator": {
"id": 100,
"name": "admin"
},
"id": 94494,
"name": "Modify tenant replica",
"startTime": "2021-03-01T15:12:07.419+08:00",
"status": "RUNNING",
"tasks": [
{
"description": "Wait alter locality",
"downstreams": [
112165
],
"id": 112163,
"name": "Wait alter locality",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
112164
]
},
{
"description": "Prepare alter tenant",
"downstreams": [
112163
],
"id": 112164,
"name": "Prepare alter tenant",
"operation": "EXECUTE",
"status": "RUNNING",
"upstreams": [
]
},
{
"description": "Sync tenant information",
"downstreams": [
112166
],
"id": 112165,
"name": "Sync tenant information",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
112163
]
},
{
"description": "Update tenant status",
"downstreams": [
],
"id": 112166,
"name": "Update tenant status",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
112165
]
}
],
"tenant": {
"id": 3,
"name": "tenant1"
}
},
"duration": 406,
"server": "a83ad33525",
"status": 200,
"successful": true,
"timestamp": "2021-03-01T15:12:07.449+08:00",
"traceId": "71f24180979c487b"
}