Overview
You can call this API to modify the IP address allow list of a tenant security IP group. For more information about how to use the whitelist, see Set a tenant security IP group.
Notice
The current API is in the whitelist. If you need to use it, please contact technical support.
API details
Constraints
The caller must have an AccessKey for accessing the multi-cloud API. For information about how to obtain the AccessKey ID and AccessKey secret, see Manage AccessKeys.
Request path
PUT /api/v2/instances/{instanceId}/tenants/{tenantId}/securityIpGroups
Request parameters
Query
| Name | Type | Required | Description | Example value |
|---|---|---|---|---|
| requestId | string | Yes | The request ID, which is used for tracing. | dc302d76-66b5-48d8-ab53-a035******** |
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**** |
Body
| Name | Type | Required | Description | Example value |
|---|---|---|---|---|
| securityIps | string | Yes | The IP address allow list. It is a JSON array. Each object in the array is an IP address or an IP segment. You can specify up to 40 IP addresses or IP segments. | "["192.190.xx.xx"]" |
| securityIpGroupName | string | Yes | The name of the IP address allow list. 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 tenant security IP group. | |
| instanceId | string | The ID of the OceanBase Cloud instance. | ob317v4uif**** |
| tenantId | string | The ID of the tenant. | t4louaeei**** |
| securityIps | string | The IP address allow list. It is a string that contains IP addresses or IP segments separated by commas. | "["192.190.xx.xx"]" |
| securityIpGroupName | string | The name of the IP address allow list. | paytest |
Examples
Request example
curl -v --location \
--digest -u '<your ak:sk>' \
--request PUT \
--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.190.xx.xx\"]", "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",
"securityIps": "[\"127.x.x.x\", \"x.x.x.x\"]",
"tenantId": "t****2u5q6l4w"
},
"requestId": "b****1010",
"success": true
}