Overview
You can call this API to delete the IP allowlist group of a tenant. For more information about how to configure the IP allowlist group of a tenant, see Configure the IP allowlist group of a tenant.
Notice
Currently, the IP allowlist feature is available only to the users who have obtained the feature. If you want to use this feature, 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
DELETE /api/v2/instances/{instanceId}/tenants/{tenantId}/securityIpGroups
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. | t4louaeei**** |
Query
| Name | Type | Required | Description | Example value |
|---|---|---|---|---|
| requestId | string | Yes | The ID of the request. This parameter is used for tracing. | dc302d76-66b5-48d8-ab53-a035******** |
Body
| Name | Type | Required | Description | Example value |
|---|---|---|---|---|
| securityIpGroupName | string | Yes | The name of the security allowlist group. The name must be 2 to 32 characters in length, start with a lowercase letter, end with a lowercase letter or a digit, and contain only lowercase letters, digits, and underscores. | paytest |
Response parameters
| Name | Type | Description | Example value |
|---|---|---|---|
| data | object | The information about the allowlist of the tenant. | |
| instanceId | string | The ID of the OceanBase Cloud instance. | ob317v4uif**** |
| tenantId | string | The ID of the tenant. | t4louaeei**** |
| securityIpGroupName | string | The name of the security allowlist group. | paytest |
Examples
Request example
curl -v --location \
--digest -u '<your ak:sk>' \
--request DELETE \
--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 '{"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": "ob****cs97mx9c",
"securityIpGroupName": "zhi****111",
"tenantId": "t****2u5q6l4w"
},
"requestId": "b****131313",
"success": true
}