Overview
You can call this API to create a singleTunnelSLB address for a tenant.
Note
This API is applicable only to tenants in instances of Alibaba Cloud.
API details
Constraints
The caller must have an AccessKey for accessing APIs of multiple clouds. 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 | The ID of the OceanBase Cloud instance. | ob317v4uif**** |
| tenantId | string | Yes | The ID of the tenant. | ob2mr3oae0**** |
Query
| Name | Type | Required | Description | Example value |
|---|---|---|---|---|
| requestId | String | Yes | The ID of the request. | 6e87d618-854e-4ca1-ae1f-babc******** |
Body
| Name | Type | Required | Description | Example value |
|---|---|---|---|---|
| userVpcId | String | Yes | The ID of the user VPC. | your-vpc-id |
| userVpcOwnerId | String | Yes | The ID of the VPC owner. | your-vpc-owner-id |
| userVswitchId | String | Yes | The ID of the user VSwitch. | your-vswitch-id |
| vipServiceType | String | Yes | The type of the address. | OBPROXY_INTRANET, OBPROXY_INTERNET, OBPROXY_READONLY, OBPROXY_READWRITE...... |
| zoneIdList | List |
No | The zones selected by the user. | ["cn-bj-d"] |
| trafficStrategy | Traffic strategy | No | AVAILABLE_ZONE_PRIORITY: prioritize the same zone, AUTO_BALANCE: auto balance, CUSTOM_WEIGHT: custom weight | |
| replicaParams | String | No | The replica. | [{"Value":"FULL", "weight": 0,"readOnlyReplicaType": ""}] |
| disasterRecoveryReplicaParams | String | No | The disaster recovery replica. | Same as above |
| balancedStrategy | String | No | The balancing strategy. | AVAILABLE_ZONE_PRIORITY: prioritize the same zone, AUTO_BALANCE: auto balance, CUSTOM_WEIGHT: custom weight |
| disasterRecoveryStrategy | String | No | The disaster recovery strategy. When the replica is unavailable, the primary replica is automatically selected. | YES |
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. | "The operation was successful." |
| data | object | The business data. | {...} |
| data.addressId | string | The ID of the VIP service group. | "12345" |
| cost | integer[int64] | The time consumed (in milliseconds). | 150 |
| server | string | The server address. | "xx.xxx.xx.xxx" |
| requestId | string | The ID of the request. | "req_20250811_001" |
| totalCount | integer[int64] | The total number. | 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
}