Overview
You can call this API to modify the specifications of an ODP cluster.
API details
Constraints
The caller must have an AccessKey for accessing the multi-cloud API. For information about how to obtain the AccessKey ID and AccessKey secret, see Manage AccessKeys.
Request path
POST /api/v2/instances/{instanceId}/proxies
Request parameters
Path
| Name |
Type |
Required |
Description |
Example value |
| instanceId |
string |
Yes |
The ID of the OceanBase Cloud instance. |
obcluster-***** |
Query
| Name |
Type |
Required |
Description |
Example value |
| requestId |
String |
Yes |
The request ID for tracking. |
dc302d76-66b5-48d8-ab53-a035******** |
Body
| Name |
Type |
Required |
Description |
Example value |
| instanceId |
String |
Yes |
The ID of the instance. |
obcluster-***** |
| proxyClusterId |
String |
Yes |
The ID of the proxy cluster. |
proxy-6tvgz6z2**** |
| unitNum |
Integer |
Yes |
The specifications. |
1 |
| mode |
String |
Yes |
The proxy mode. |
k8s_shared, k8s_exclusive |
| zone |
String |
Yes |
The zone. |
ap-beijing-5 |
| odpClusterNodeType |
String |
Yes |
The node type of the ODP cluster. This parameter is required for one-click POC scenarios. |
normal |
| UID |
String |
No |
The user ID. |
|
| User_ID |
String |
No |
The user ID. |
|
| requestId |
String |
No |
The request ID. |
|
| callerType |
String |
No |
The caller type. |
|
| accessKeyId |
String |
No |
The AccessKey ID. |
|
| securityToken |
String |
No |
The security token. |
|
| callerUid |
String |
No |
The caller UID. |
|
| callerBid |
String |
No |
The caller BID. |
|
| stsTokenCallerUid |
String |
No |
The STS token caller UID. |
|
| stsTokenCallerBid |
String |
No |
The STS token caller BID. |
|
| acceptLanguage |
String |
No |
The accepted language. |
|
| pageNumber |
Integer |
No |
The page number. |
|
| pageSize |
Integer |
No |
The page size. |
|
| mergedCallerBid |
String |
No |
The merged caller BID. |
|
Response parameters
| Name |
Type |
Description |
Example value |
| success |
boolean |
Indicates whether the request was successful. |
true/false |
| errorCode |
string |
The error code. |
"E001" |
| errorMessage |
string |
The error message. |
"The operation was successful." |
| data |
object |
The business data. |
{...} |
| cost |
integer[int64] |
The time consumed (in milliseconds). |
150 |
| server |
string |
The server address. |
"xx.xxx.xx.xxx" |
| requestId |
string |
The request ID. |
"req_20250811_001" |
| totalCount |
integer[int64] |
The total number of items. |
100 |
| extra |
object |
The additional information. |
{"key1": "value1"} |
Examples
Request example
curl --digest -u '<Your AccessKey ID:AccessKey secret>' \
--request POST \
--url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/proxies?requestId={requestId}' \
-H 'Content-Type: application/json' \
-H 'X-Ob-Project-Id: <Project ID>' \
--data '{"instanceId":"obcluster-*****","proxyClusterId":"proxy-6tvgz6z2****","unitNum":2,"mode":"k8s_exclusive","zone":"ap-beijing-5","odpClusterNodeType":"normal"}'
Note
- A project ID uniquely identifies a project. For information about how to obtain the project ID of an instance, see Manage projects.
- Make sure that the project ID corresponding to the specified instanceId is consistent with the specified project ID.
Response example
{
"success": true,
"errorCode": "E001",
"errorMessage": "The operation was successful.",
"data": {},
"cost": 150,
"server": "xxx.xxx.x.xxx:xxxx",
"requestId": "req_20250811_001",
"totalCount": 100,
"extra": {}
}
