ModifyTenantSecurityIpGroup - ApsaraDB for OceanBase - Alibaba Cloud Documentation Center

You can call this operation to modify the information on the whitelist group of 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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
oceanbase:ModifyTenantSecurityIpGroup	update	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the OceanBase cluster.	ob317v4uif****
TenantId	string	Yes	The ID of the tenant.	t4louaeei****
SecurityIpGroupName	string	Yes	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
SecurityIps	string	Yes	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

Parameter	Type	Description	Example
	object	The returned result of the request.
RequestId	string	The request ID.	EE205C00-30E4-**-**-87E3A8A2AA0C
SecurityIpGroup	object	The information of the IP address whitelist group.
InstanceId	string	The ID of the OceanBase cluster.	ob317v4uif****
TenantId	string	The ID of the tenant.	t4louaeei****
SecurityIpGroupName	string	The name of the whitelist group.	paytest
SecurityIps	string	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 a 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 time	Summary of changes	Operation

No change history