Overview
You can call this API to create a tenant security IP group. For more information about how to configure a tenant security IP group, see Configure a tenant security IP group.
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}/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 |
|---|---|---|---|---|
| securityIps | string | Yes | The list of IP addresses in the security IP group. 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. | "["192.*.."]" |
| securityIpGroupName | string | Yes | The name of the security IP group. It 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. | |
| tenantId | string | The ID of the tenant. | t4louaeei**** |
| securityIpGroupName | string | The name of the security IP group. | paytest |
| securityIpGroupType | string | The type of the security IP group.
|
|
| securityIps | string | The list of IP addresses in the security IP group. It is a string that contains IP addresses or IP segments separated by commas. | "["192.*.."]" |
Examples
Request example
curl -v --location \
--digest -u 'xxx:xxx' \
--request POST \
--url https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/securityIpGroups
-H 'X-Ob-Project-Id: <Project ID>'
--data \ '{"securityIps":"xxx", "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": "ob3n****7mx9c",
"securityIpGroupName": "zhi****111",
"securityIps": "[\"127.x.x.x\", \"x.x.x.x\"]",
"tenantId": "t****2u5q6l4w"
},
"requestId": "b****1010",
"success": true
}