All Products
Search
Document Center

ApsaraDB for OceanBase:DescribeSecurityIpGroups

Last Updated:Apr 29, 2024

You can call this operation to view the list of IP address whitelist groups.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the OceanBase cluster.

i-bp67acfmxazb4p****

Response parameters

ParameterTypeDescriptionExample
object

The list of IP addresses and CIDR blocks in the whitelist.
It is a JSON array. Each object in the array is an IP address or CIDR block.

RequestIdstring

The request ID.

EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
TotalCountinteger

Example 1

2
SecurityIpGroupsobject []

Examples

Sample success responses

JSONformat

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "TotalCount": 2,
  "SecurityIpGroups": [
    {
      "SecurityIps": "",
      "SecurityIpGroupName": "online_paycore"
    }
  ]
}

Error codes

HTTP status codeError codeError message
500InternalErrorThe request processing has failed due to some unknown error.

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

Change history

Change timeSummary of changesOperation
No change history