All Products
Search
Document Center

PolarDB:DescribeDrdsDBIpWhiteList

Last Updated:Oct 27, 2023

Queries the IP address whitelist for a specified DRDS database.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer automatically generates the sample code of the operation for different SDKs.

Request parameters

Parameter

Type

Required

Example

Description

Action

String

Yes

DescribeDrdsDBIpWhiteList

The operation that you want to perform. Set the value to DescribeDrdsDBIpWhiteList.

RegionId

String

Yes

cn-hangzhou

The ID of the region in which you want to create the instance.

DbName

String

Yes

test_db

The database name.

DrdsInstanceId

String

Yes

drds********

The instance ID.

GroupName

String

No

group1

The name of the whitelist group.

Response parameters

Parameter

Type

Example

Description

IpWhiteList

List

10.23.***. ***,10.23. ***. ***/24

The IP address whitelist.

RequestId

String

017453B9-0001-4745-87BF-DD612D850ED0

The ID of the request.

Success

Boolean

true

Indicates whether the request is successful.

Examples

Sample requests

http(s)://drds.aliyuncs.com/? Action=DescribeDrdsDBIpWhiteList
&RegionId=cn-hangzhou
&DbName=test_db
&DrdsInstanceId=drds********
&<Common request parameters>

Sample success responses

XML format

<DescribeDrdsDBIpWhiteListResponse>
	  <RequestId>017453B9-0001-4745-87BF-DD612D850ED0</RequestId>
	  <IpWhiteList>
		    <Ip>10.23. ***. ***</Ip>
		    <Ip>10.23. ***. ***/24</Ip>
	  </IpWhiteList>
	  <Success>true</Success>
</DescribeDrdsDBIpWhiteListResponse>

JSON format

{
    "RequestId": "017453B9-0001-4745-87BF-DD612D850ED0",
    "IpWhiteList": {
        "Ip": [
            "10.23. ***. ***",
            "10.23. ***. ***/24"
        ]
    },
    "Success": true
}

Error codes

HttpCode

Error code

Error message

Description

400

ActionUnauthorized

The specified action is not available for you

The error message returned because you are not authorized to perform this action. Perform Resource Access Management (RAM) authorization first.

For a list of error codes, visit the API Error Center.