Overview
You can call this API to create a new network endpoint for a specified tenant. By configuring the virtual IP service type, VPC connection information, and proxy settings, you can establish a new access endpoint for the tenant, allowing applications to connect to the tenant in an OceanBase Cloud database instance.
API details
Constraints
The caller must have an AccessKey for accessing multi-cloud APIs. For information about how to obtain the AccessKey ID and AccessKey secret, see Manage AccessKeys.
Request path
POST /api/v2/instances/{instanceId}/tenants/{tenantId}/address
Request parameters
Path
Parameter |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| instanceId | string | Yes | The ID of the database instance in OceanBase Cloud. | obcluster-***** |
| tenantId | string | Yes | The ID of the tenant. | t4louaeei**** |
Query
Parameter |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| requestId | string | Yes | The ID of the request, which is used for tracing. | dc302d76-66b5-48d8-ab53-a035******** |
Header
Parameter |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| X-Ob-Project-Id | string | Yes | The ID of the project. | hxq3ztx3377nby3v87ry**** |
Body
Parameter |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| vipServiceType | string | Yes | The virtual IP service type. | - |
| vpcConnectionInfoId | integer | Yes | The ID of the VPC connection information. | - |
| proxySetting | object | No | The proxy settings. | - |
Response parameters
Parameter |
Type |
Description |
|---|---|---|
| data | object | The returned data object. |
| message | string | The message returned from the request. |
| successful | boolean | Indicates whether the request was successful. |
Examples
Request example
curl -X POST \
-H "Content-Type: application/json" \
-H "X-Ob-Project-Id: hxq3ztx3377nby3v87ry****" \
-u '<your ak:sk>' \
"https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/address?requestId={requestId}" \
-d '{
"vipServiceType": "string",
"vpcConnectionInfoId": 0,
"proxySetting": {}
}'
Response example
{
"data": {},
"message": "Success",
"successful": true
}