All Products
Search
Document Center

ApsaraDB for OceanBase:DescribeTenantSecurityIpGroups

Last Updated:Sep 12, 2024

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

Debugging

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

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
oceanbase:DescribeTenantSecurityIpGroupsget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the OceanBase cluster.

ob317v4uif****
TenantIdstringYes

The ID of the tenant.

t4louaeei****

Response parameters

ParameterTypeDescriptionExample
object

The returned result of the request.

RequestIdstring

The request ID.

473469**-AA6F-4D**-B3DB-A***********
TotalCountinteger

The total number of the whitelist groups.

2
SecurityIpGroupsarray<object>

The list of the whitelist groups.

object
SecurityIpGroupNamestring

The group name.

test1
SecurityIpsstring

The whitelist of IP addresses. It is a string separated by commas, and each object is an IP string or a CIDR block.

192.***.*.*"
SecurityIpGroupTypestring

The whitelist group type.

  • instance: the whitelist group from the cluster.
  • tenant: the whitelist group of the current tenant.
tenant
TenantIdstring

The ID of the tenant.

t4louaeei****

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469**-AA6F-4D**-B3DB-A***********",
  "TotalCount": 2,
  "SecurityIpGroups": [
    {
      "SecurityIpGroupName": "test1",
      "SecurityIps": "192.***.*.*\"",
      "SecurityIpGroupType": "tenant",
      "TenantId": "t4louaeei****"
    }
  ]
}

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