All Products
Search
Document Center

:CreateSecurityIpGroup

Last Updated:Mar 14, 2023

You can call this operation to create an IP address whitelist group.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the OceanBase cluster.

ob317v4uif****
SecurityIpsstringYes

The IP addresses or CIDR blocks in the IP address whitelist group.
It is a JSON array. Each object in the array is an IP address or CIDR block. The following two formats are supported:

  • IP address: for example, 10.23.12.24.
  • CIDR block: for example, 10.23.12.24/24, where 24 indicates the length of the prefix in the IP address, and the prefix is 1 to 30 characters in length. Limit: You can set no more than 40 IP addresses or CIDR blocks for a whitelist group. A total of 200 IP addresses or CIDR blocks are supported for all whitelist groups.
{"192.168.1.1","192.168.0.0.1/8"}
SecurityIpGroupNamestringYes

The name of the whitelist group.

pay_online

Response parameters

ParameterTypeDescriptionExample
object

The return result of the request.

RequestIdstring

The request ID.

EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
SecurityIpGroupobject

The information of the whitelist group.

InstanceIdstring

The ID of the OceanBase cluster.

ob317v4uif****
SecurityIpGroupNamestring

The name of the whitelist group.

pay_online
SecurityIpsstring

The IP addresses or CIDR blocks in the IP address whitelist group.
The return values of SecurityIps are strings that are separated with commas (,).

192.168.1.1,192.168.0.0.1/8

Examples

Sample success responses

JSONformat

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "SecurityIpGroup": {
    "InstanceId": "ob317v4uif****",
    "SecurityIpGroupName": "pay_online",
    "SecurityIps": "192.168.1.1,192.168.0.0.1/8"
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history