All Products
Search
Document Center

ApsaraDB RDS:DescribeDBInstanceIPArrayList

Last Updated:Jan 16, 2024

Queries the IP address whitelist of an ApsaraDB RDS instance.

Operation description

Supported database engines

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server
  • RDS MariaDB

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
rds:DescribeDBInstanceIPArrayListREAD
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The instance ID. You can call the DescribeDBInstances operation to query the instance ID.

rm-uf6wjk5xxxxxxx
WhitelistNetworkTypestringNo

The network type of the IP address whitelist. Valid values:

  • Classic: classic network in enhanced whitelist mode
  • VPC: virtual private cloud (VPC) in enhanced whitelist mode
  • MIX: standard whitelist mode

By default, this operation returns IP address whitelists of all network types.

VPC

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

E2B6AF71-DC32-4055-B477-43B348798D10
Itemsobject []

An array that consists of the details about the IP address whitelists.

DBInstanceIPArrayAttributestring

The attribute of the IP address whitelist. By default, this parameter is empty.

Note A whitelist with the hidden attribute does not appear in the console. Such IP address whitelists are used to access Alibaba Cloud services, such as Data Transmission Service (DTS).
hidden
DBInstanceIPArrayNamestring

The name of the IP address whitelist.

rds_default
SecurityIPTypestring

The type of the IP address.

IPv4
SecurityIPListstring

The IP addresses in the IP address whitelist.

192.168.1.0/24

Examples

Sample success responses

JSONformat

{
  "RequestId": "E2B6AF71-DC32-4055-B477-43B348798D10",
  "Items": {
    "DBInstanceIPArray": [
      {
        "DBInstanceIPArrayAttribute": "hidden",
        "DBInstanceIPArrayName": "rds_default",
        "SecurityIPType": "IPv4",
        "SecurityIPList": "192.168.1.0/24"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidEndpointType.FormatThe specified EndpointType is invalid.The value of the EndpointType parameter is invalid. Check the value of this parameter.
400InvalidParameterInvalid parameter.The values of some parameters are invalid.
400InvalidParameter.OwnerAccountThe specified OwnerAccount is invalid.The operation failed. The value of the OwnerAccount parameter is invalid. Check the value of this parameter.
400WhitelistNetType.FormatThe specified is WhitelistNetType not valid.-
403IncorrectDBInstanceCharacterTypeCurrent DB Instance character_type does not support this operation.This operation is not supported for the character type of the current instance.
404InvalidDBInstanceName.NotFoundThe database instance does not exist.The name of the RDS instance cannot be found. Check the name of the RDS instance.

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