This API is used to set cluster-level parameters, including clusterId, clusterName, rsList, and rootPwd. Cluster-level parameters take effect on all nodes in the cluster.
Call description
Limitations
If you set a password in the request, you must specify the X-OCS-Auth field in the header for authentication. For more information, see Authentication based on public-key encryption.
Request path
POST /api/v1/obcluster/config PUT /api/v1/obcluster/config
Request parameters
| Parameter | Type | Required | Example value | Description |
|---|---|---|---|---|
| clusterId | String | No | 1 | The ID of the cluster. |
| clusterName | String | No | ob-test | The name of the cluster. |
| rootPwd | String | No | The password of the cluster. You must encrypt the password. For more information, see Authentication based on public-key encryption. | |
| rsList | String | No | "xx.xxx.xx.xx:2882:2881" | The RootService list of the cluster in the format of observer_ip:rpc_port:mysql_port. Separate the information of multiple servers with semicolons (;). |
Response parameters
| Parameter | Type | Description |
|---|---|---|
| successful | Boolean | Indicates whether the request is successful. |
| timestamp | Datetime | The timestamp when the server completed the request. |
| duration | Integer | The amount of time taken by the server to process the request, in milliseconds. |
| status | Integer | The HTTP status code. |
| traceId | String | The trace ID of the request. |
| data | Object | The information about the asynchronous task. For more information, see GetDagDetails. |
| error | Object | The information about the error that occurred. |
Examples
Sample request
"{
"clusterId":1,
"clusterName":"upgrade",
"rootPwd":"SlCfrxyY+iJom1G8Ad74PZ2Rz46W9fY4ffxr+Lt0uKJQnyamfwVvMo9cJ0CqoccZS0p4FH+U3vJXH4C62O3/SLttVGRLblJzPKRyKYdZU59fjhBwyjrsLc5ZwsWsJpsN5kuFyb3gCEO5vVmQKxqJmwQjAdpYWuPAU0xzBA8QM6o="
}"
Sample response
{
"successful": true,
"timestamp": "2024-01-09T15:14:26.299401393+08:00",
"duration": 1,
"status": 200,
"traceId": "6328313e8d9fd63b",
"data": {
"id": "22130706433028869",
"dag_id": 2,
"name": "Update cluster config",
"stage": 1,
"max_stage": 1,
"state": "READY",
"operator": "RUN",
"start_time": "2024-01-09T15:14:26.29828992+08:00",
"end_time": "2024-01-09T15:14:26.29828992+08:00",
"additional_data": null,
"nodes": null
}
}