Overview
You can call this API to query the list of tenant allowlists. For more information about how to use allowlists, see Set tenant allowlists.
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
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 cluster. | ob317v4uif**** |
| tenantId | string | Yes | The ID of the tenant. | t4louaeei**** |
Response parameters
| Name | Type | Description | Example value |
|---|---|---|---|
| data | object | The information about the tenant allowlists, including the dataList parameter. | |
| dataList | object[] | The list of tenant allowlists, including the following parameters. | |
| tenantId | string | The ID of the tenant. | t4louaeei**** |
| securityIpGroupName | string | The name of the allowlist. | test1 |
| securityIpGroupType | string | The type of the allowlist.
|
tenant |
| securityIps | string | The list of allowlisted IP addresses. It is a string that contains IP addresses or IP segments, 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
}
