Overview
You can call this API to create an singleTunnelSLB address for a tenant.
Note
This API applies only to tenants under instances whose cloud vendor is Alibaba Cloud.
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
POST /api/v2/instances/{instanceId}/tenants/{tenantId}/tenantSingleTunnelSLBAddress
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 |
|---|---|---|---|---|
| userVpcId | String | User VPC ID | your-vpc-id | |
| userVpcOwnerId | String | VPC Owner ID | your-vpc-owner-id | |
| userVswitchId | String | User Vswitch ID | your-vswitch-id | |
| vipServiceType | String | Address type | OBPROXY_INTRANET, OBPROXY_INTERNET, OBPROXY_READONLY, OBPROXY_READWRITE...... | |
| zoneIdList | List |
User selected zone | ["cn-bj-d"] | |
| trafficStrategy | Load balancing strategy | AVAILABLE_ZONE_PRIORITY: Same zone priority, AUTO_BALANCE: Automatic balancing, CUSTOM_WEIGHT: Custom weight | ||
| replicaParams | String | Replica selection | [{"Value":"FULL", "weight": 0,"readOnlyReplicaType": ""}] | |
| disasterRecoveryReplicaParams | String | Failover replica selection | Same as above | |
| balancedStrategy | String | Balancing strategy | AVAILABLE_ZONE_PRIORITY: Same zone priority, AUTO_BALANCE: Automatic balancing, CUSTOM_WEIGHT: Custom weight | |
| disasterRecoveryStrategy | String | Failover strategy. Automatically checks the primary replica when the current replica is unavailable. | YES |
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 POST \
--url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/tenantSingleTunnelSLBAddress'\
-H 'X-Ob-Project-Id: <Project ID>'\
--data \ '{"userVpcId":"xxx", "userVpcOwnerId": "xxx", "userVswitchId": "xxx", "vipServiceType": "OBPROXY_INTRANET"}'
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
JSON format
{
"data": {
"addressId": "rs-private-internet-751bc080-d862-4917-972e-48ae3d22****-OBPROXY-INTERNET-t6zffysc2bg2o-****"
},
"requestId": "6e87d618-854e-4ca1-ae1f-babcffd70000",
"success": true
}