Overview
You can call this API to modify the tenant address port.
API details
Constraints
The caller must have an AccessKey for accessing APIs of OceanBase Cloud. For information about how to obtain the AccessKey ID and AccessKey secret, see Manage AccessKeys.
Request path
PUT /api/v2/instances/{instanceId}/tenants/{tenantId}/addressPort
Request parameters
Path
| Name | Type | Required | Description | Example Value |
|---|---|---|---|---|
| instanceId | string | Yes | OceanBase instance ID. | ob317v4uif**** |
| tenantId | string | Yes | Tenant ID. | ob2mr3oae0**** |
Query
| Name | Type | Required | Description | Example Value |
|---|---|---|---|---|
| requestId | String | Yes | Request ID | 6e87d618-854e-4ca1-ae1f-babc******** |
Body
| Name | Type | Required | Description | Example Value |
|---|---|---|---|---|
| addressId | String | Yes | Endpoint ID | your-endpoint-id |
| proxyClusterId | String | Yes | Proxy cluster ID | proxy-6tvgz6z2**** |
| serviceType | String | Yes | Endpoint type | OBPROXY_INTRANET, OBPROXY_INTERNET, OBPROXY_READONLY, OBPROXY_READWRITE...... |
| port | Integer | Yes | New port | 12345 |
Response parameters
| Name | Type | Description | Example Value |
|---|---|---|---|
| success | boolean | Whether the operation succeeded. | true/false |
| errorCode | string | Error code. | "E001" |
| errorMessage | string | Error message. | "Operation succeeded." |
| data | object | Business data. | {...} |
| data.addressId | string | VIP service group name. | "12345" |
| cost | integer[int64] | Time consumed, in milliseconds. | 150 |
| server | string | Server address. | "192.168.1.100" |
| requestId | string | Request ID. | "req_20250811_001" |
| totalCount | integer[int64] | Total count. | 100 |
| extra | object | Additional information. | {"key1": "value1"} |
Examples
Request example
curl --digest -u 'ak:sk' \
--request PUT \
--url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/addressPort'\
-H 'X-Ob-Project-Id: <Project ID>'\
--data \ '{"addressId":"xxx", "proxyClusterId": "xxx", "serviceType": "xxx", "port": 3306}'
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
None
