Queries the IP address whitelists of a PolarDB-X instance.

Debugging

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

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeSecurityIps

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

RegionId String Yes cn-hangzhou

The region ID of the instance.

DBInstanceName String Yes pxc-hzjasd****

The name of the instance.

Response parameters

Parameter Type Example Description
Message String success

The additional information returned for the request. If "success" is returned, the request is successful. If an error code is returned, the request failed.

RequestId String 14036EBE-CF2E-44DB-ACE9-AC6157D3A6FC

The ID of the request.

Success Boolean true

Indicates whether the request is successful.

Data Object

The returned data.

DBInstanceName String pxc-hzjasd****

The name of the instance.

GroupItems Array of GroupItem

The details about the IP address whitelists.

GroupName String defaultGroup

The name of the IP address whitelist.

SecurityIPList String 127.0.0.1,172.168.0.0

The IP addresses and CIDR blocks that are specified in the IP address whitelist.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeSecurityIps
&RegionId=cn-hangzhou
&DBInstanceName=pxc-hzjasd****
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeSecurityIpsResponse>
    <Message>success</Message>
    <RequestId>14036EBE-CF2E-44DB-ACE9-AC6157D3A6FC</RequestId>
    <Success>true</Success>
    <Data>
        <DBInstanceName>pxc-hzjasd****</DBInstanceName>
        <GroupItems>
            <GroupName>defaultGroup</GroupName>
            <SecurityIPList>127.0.0.1,172.168.0.0</SecurityIPList>
        </GroupItems>
    </Data>
</DescribeSecurityIpsResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Message" : "success",
  "RequestId" : "14036EBE-CF2E-44DB-ACE9-AC6157D3A6FC",
  "Success" : true,
  "Data" : {
    "DBInstanceName" : "pxc-hzjasd****",
    "GroupItems" : [ {
      "GroupName" : "defaultGroup",
      "SecurityIPList" : "127.0.0.1,172.168.0.0"
    } ]
  }
}

Error codes

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