Overview
You can call this API to change the specifications of a database proxy cluster.
API details
Constraints
The caller must have an AccessKey for accessing APIs of Alibaba Cloud. 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 ApsaraDB for OceanBase instance. | obcluster-***** |
Query
Name |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| requestId | String | Yes | The ID of the request. This ID is used for troubleshooting. | 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 | No | The number of units in the proxy cluster.
NoteIf you specify the proxy settings in the ProxySetting parameter, this parameter is automatically included and does not need to be specified separately. |
1 |
| mode | String | No | The mode of the proxy cluster.
NoteIf you specify the proxy settings in the ProxySetting parameter, this parameter is automatically included and does not need to be specified separately. |
k8s_shared, k8s_exclusive |
| zone | String | No | The zone of the proxy cluster.
NoteIf you specify the proxy settings in the ProxySetting parameter, this parameter is automatically included and does not need to be specified separately. |
ap-beijing-5 |
| odpClusterNodeType | String | Yes | The type of the ODP cluster node. This parameter is required for one-click POC scenarios. | normal |
| ProxySetting | Object | No | The proxy settings, which include the unitNum, mode, and zone parameters.
NoteThis parameter is supported only for instances of the AWS channel. |
|
| -mode | String | No | The type of the proxy cluster. Valid values: k8s_shared and k8s_exclusive. | k8s_shared |
| -deploymentArchitecture | String | No | The deployment architecture of the proxy cluster.
|
DUAL_AZ_ACTIVE_ACTIVE_DEPLOYMENT |
| -zone | Array | No | The zone of the primary node. | ["us-east-1a","us-east-1b"] |
| -slaveZone | Array | No | The zone of the standby node. This parameter is required only if you choose the DUAL_AZ_ACTIVE_STANDBY_DEPLOYMENT or DUAL_AZ_ACTIVE_ACTIVE_DEPLOYMENT deployment architecture. | [] |
| -nodeCpu | Float | No | The specifications of the node. | The minimum value is 0.5, and the increment is 0.5. |
| UID | String | No | The ID of the user. | |
| User_ID | String | No | The ID of the user. | |
| requestId | String | No | The ID of the request. | |
| callerType | String | No | The type of the caller. | |
| accessKeyId | String | No | The ID of the AccessKey. | |
| securityToken | String | No | The security token. | |
| callerUid | String | No | The UID of the caller. | |
| callerBid | String | No | The BID of the caller. | |
| stsTokenCallerUid | String | No | The UID of the caller for the STS token. | |
| stsTokenCallerBid | String | No | The BID of the caller for the STS token. | |
| acceptLanguage | String | No | The language accepted. | |
| pageNumber | Integer | No | The page number. | |
| pageSize | Integer | No | The number of entries on each page. | |
| mergedCallerBid | String | No | The merged BID of the caller. |
Response parameters
Name |
Type |
Description |
Example value |
|---|---|---|---|
| success | boolean | Indicates whether the operation succeeded. | true/false |
| errorCode | string | The error code. | "E001" |
| errorMessage | string | The error message. | "Operation succeeded" |
| data | object | The business data. | {...} |
| cost | integer[int64] | The time consumed (in milliseconds) | 150 |
| server | string | The IP address of the server. | "xx.xxx.xx.xxx" |
| requestId | string | The ID of the request. | "req_20250811_001" |
| totalCount | integer[int64] | The total number of entries. | 100 |
| extra | object | The additional information. | {"key1": "value1"} |
Examples
Request example
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.
Example 1: Pass the proxy settings by using the proxySetting parameter.
curl --digest -u '<your ak:sk>' \
--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****","odpClusterNodeType":"normal","proxySetting":{"mode":"k8s_shared","deploymentArchitecture":"DUAL_AZ_ACTIVE_ACTIVE_DEPLOYMENT","nodeCpu":0.5,"zone":["us-east-1a","us-east-1b"],"slaveZone":[]}}'
Example 2: Pass the specifications by using the specifications parameter.
curl --digest -u '<your ak:sk>' \
--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"}'
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": {}
}