Overview
You can call this API to query the allowlists 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
GET /api/v2/instances/{instanceId}/tenants/{tenantId}/securityIpGroups
Request parameters
Query
| Parameter | 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
| Parameter | Type | Description | Example value |
|---|---|---|---|
| data | Object | The information about the allowlists of the tenant, including the dataList parameter. | |
| dataList | Object[] | The list of information about the allowlists of the tenant, 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. Valid values:
|
tenant |
| securityIps | String | The items in the allowlist. The value is a string of objects separated with commas (,). Each object is an IP address or a CIDR block. | 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
}