Overview
You can call this API to create a new IP allowlist for a tenant and configure the IP address range that is allowed to access. For more information about how to use an allowlist, see Set up an allowlist for a tenant.
Notice
The API is available only for allowlists. If you want to use this API, contact Technical Support.
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}/securityIpGroups
Request parameters
Query
| 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. | t4louaeei**** |
| requestId | string | Yes | The ID of the request, which is used for tracing. | dc302d76-66b5-48d8-ab53-a035******** |
Body
| Name | Type | Required | Description | Example value |
|---|---|---|---|---|
| securityIps | string | Yes | The list of IP addresses in the allowlist. It is a JSON array. Each object in the array is an IP address or an IP segment. The maximum number of IP addresses or IP segments is 40. | "["192.*.."]" |
| securityIpGroupName | string | Yes | The name of the allowlist. The name must be 2 to 32 characters in length, start with a lowercase letter, and end with a lowercase letter or a digit. It can contain only lowercase letters, digits, and underscores. | paytest |
Response parameters
| Name | Type | Description | Example value |
|---|---|---|---|
| data | object | The information about the allowlist. | |
| tenantId | string | The ID of the tenant. | t4louaeei**** |
| securityIpGroupName | string | The name of the allowlist. | paytest |
| securityIpGroupType | string | The type of the allowlist.
|
|
| securityIps | string | The list of IP addresses in the allowlist. It is a string that contains IP addresses or IP segments separated by commas. | "["192.*.."]" |
Examples
Request example
curl -v --location \
--digest -u '<your ak:sk>' \
--request POST \
--url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/securityIpGroups?requestId={requestId}' \
-H 'X-Ob-Project-Id: <Project ID>' \
-H 'Content-Type: application/json' \
--data '{"securityIps":"[\"192.*..\"]", "securityIpGroupName": "paytest"}'
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": {
"instanceId": "ob3n****7mx9c",
"securityIpGroupName": "zhi****111",
"securityIps": "[\"127.x.x.x\", \"x.x.x.x\"]",
"tenantId": "t****2u5q6l4w"
},
"requestId": "b****1010",
"success": true
}