Overview
You can call this API to query the list of tenant allowlist groups. For more information about how to use allowlist groups, see Set tenant allowlist groups.
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
GET /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**** |
Response parameters
| Name | Type | Description | Example value |
|---|---|---|---|
| data | object | The allowlist information of the tenant, including the dataList attribute. | |
| dataList | object[] | The list of allowlist information of the tenant, including the following attributes. | |
| tenantId | string | The ID of the tenant. | t4louaeei**** |
| securityIpGroupName | string | The name of the allowlist group. | test1 |
| securityIpGroupType | string | The type of the allowlist group.
|
tenant |
| securityIps | string | The list of allowed IP addresses. The value is a string in which IP addresses or IP segments are separated by commas. | 192.***.*.* |
Examples
Request example
curl
--digest -u 'xxx:xxx' \
--request GET \
--url https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/securityIpGroups
-H 'X-Ob-Project-Id: <Project ID>'
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": {
"dataList": [
{
"securityIpGroupName": "zhi****test",
"securityIpGroupType": "tenant",
"securityIps": "[\"127.x.x.x\", \"127.x.x.x\", \"x.x.x.x\"]",
"tenantId": "t****2u5q6l4w"
},
{
"securityIpGroupName": "s****",
"securityIpGroupType": "tenant",
"securityIps": "[\"x.x.x.x\"]",
"tenantId": "t****2u5q6l4w"
}
],
"total": 2
},
"requestId": "b****12121212",
"success": true
}