All Products
Search
Document Center

ApsaraDB for OceanBase:CreateTenantSecurityIpGroup

Last Updated:Oct 23, 2024

You can call this operation to create the security whitelist for the tenant.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the OceanBase cluster.

ob317v4uif****
TenantIdstringYes

The ID of the tenant.

t4louaeei****
SecurityIpGroupNamestringYes

The group name of the whitelist group of IP addresses.

It starts with lowercase letters and ends with lowercase letters or numbers. It can only contain lowercase letters, numbers, and underscores, and should be 2~32 characters in length.

paytest
SecurityIpsstringYes

The list of IP addresses in the whitelist group.

It is a JSON array. Each object in the array is an IP address or a CIDR block. You can have up to 40 whitelists.

192.***.*.*"

Response parameters

ParameterTypeDescriptionExample
object

The returned result of the request.

RequestIdstring

The request ID.

EE205C00-30E4-****-****-87E3A8A2AA0C
SecurityIpGroupobject

The information of the whitelist group.

InstanceIdstring

The ID of the OceanBase cluster.

ob317v4uif****
TenantIdstring

The ID of the tenant.

t4louaeei****
SecurityIpGroupNamestring

The name of the whitelist group.

paytest
SecurityIpsstring

The list of IP addresses in the IP address whitelist group.

It is a string separated by commas, and each object is an IP address or CIDR block.

192.***.*.*

Examples

Sample success responses

JSONformat

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "SecurityIpGroup": {
    "InstanceId": "ob317v4uif****",
    "TenantId": "t4louaeei****",
    "SecurityIpGroupName": "paytest",
    "SecurityIps": "192.***.*.*"
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history