All Products
Search
Document Center

AnalyticDB:CreateDBInstanceIPArray

Last Updated:Nov 10, 2025

Adds an IP whitelist group.

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

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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
gpdb:CreateDBInstanceIPArraycreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The cluster ID.

Note You can call the DescribeDBInstances operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.
gp-xxxxxxxxx
IPArrayNamestringYes

The name of the IP whitelist group.

testarray
IPArrayAttributestringNo

The attribute of the IP whitelist group.

taffyFish
SecurityIPListarrayYes

The IP addresses in the IP whitelist group. A maximum of 1,000 IP addresses or CIDR blocks are allowed.

stringYes

A comma-separated list of IP addresses and CIDR blocks for the IP whitelist group. You can specify up to 1,000 entries. Supported formats:

  • Single IP: 10.23.12.24
  • CIDR Block: 10.23.12.0/24 (The /24 denotes the network prefix length, which must be an integer and the range is [1,32].)
172.28.80.0/20

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

API-d971c90f-c801-41bd-b8e5-5b8bd79326c8

Examples

Sample success responses

JSONformat

{
  "RequestId": "API-d971c90f-c801-41bd-b8e5-5b8bd79326c8"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2025-11-05Add OperationView Change Details