Overview
You can call this API to delete the information of the security IP group of a tenant. For more information about how to use the security IP group, see Set the security IP group of a tenant.
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
DELETED /api/v2/instances/{instanceId}/tenants/{tenantId}/securityIpGroups
Request parameters
Query
| Name | Type | Required | Description | Example value |
|---|---|---|---|---|
| instanceId | string | Yes | The ID of the OceanBase cluster. | ob317v4uif**** |
| tenantId | string | Yes | The ID of the tenant. | t4louaeei**** |
Body
| Name | Type | Required | Description | Example value |
|---|---|---|---|---|
| securityIpGroupName | string | Yes | The name of the security IP group. The name must start with a lowercase letter and end with a lowercase letter or a number. It can contain only lowercase letters, numbers, and underscores. The name must be 2 to 32 characters in length. | paytest |
Response parameters
| Name | Type | Description | Example value |
|---|---|---|---|
| data | object | The information of the security IP group of the tenant. | |
| instanceId | string | The ID of the OceanBase cluster. | ob317v4uif**** |
| tenantId | string | The ID of the tenant. | t4louaeei**** |
| securityIpGroupName | string | The name of the security IP group. | paytest |
Examples
Request example
curl -v --location \
--digest -u 'xxx:xxx' \
--request DELETE \
--url https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/securityIpGroups
-H 'X-Ob-Project-Id: <Project ID>'
--data \ '{"securityIpGroupName": "xxx"}'
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
}