调用DescribeSecurityIps接口查看实例的白名单信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeSecurityIps

系统规定参数。取值为DescribeSecurityIps

DBInstanceName String pxc-***************

实例ID。

RegionId String cn-hangzhou

实例所在地域。

返回数据

名称 类型 示例值 描述
Data Struct

实例白名单信息。

DBInstanceName String pxc-***************

实例ID。

GroupItems Array of GroupItem

实例白名单分组信息。

GroupName String test

白名单组名。

SecurityIPList String 127.***.****.1,192.***.***.100

白名单列表,多个IP白名单间用英文逗号(,)分隔 。

Message String ****

请求返回消息。

说明 请求成功时该参数为空,请求失败时会返回请求异常信息(如错误码等)。
RequestId String 0C2EF117-38F2-4D09-BF35-18D591******

请求ID。

Success Boolean true

请求是否成功。

示例

请求示例

http(s)://polardbx.cn-hangzhou.aliyuncs.com/?Action=DescribeSecurityIps
&DBInstanceName=pxc-***************
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML 格式

<code>200</code>
<data>
    <RequestId>0C2EF117-38F2-4D09-BF35-18D591******</RequestId>
    <Message/>
    <Data>
        <GroupItems>
            <GroupName>test</GroupName>
            <SecurityIPList>127.***.****.1,192.***.***.100</SecurityIPList>
        </GroupItems>
        <DBInstanceName>pxc-***************</DBInstanceName>
    </Data>
    <Success>true</Success>
</data>
<requestId>0C2EF117-38F2-4D09-BF35-18D591******</requestId>
<successResponse>true</successResponse>

JSON 格式

{
  "code":"200",
  "data":{
    "RequestId": "0C2EF117-38F2-4D09-BF35-18D591******",
    "Message": "",
    "Data": {
      "GroupItems": [{
        "GroupName": "test",
        "SecurityIPList": "127.***.****.1,192.***.***.100"
      }],
      "DBInstanceName": "pxc-***************"
    },
    "Success": true 
  },
  "requestId":"0C2EF117-38F2-4D09-BF35-18D591******",
  "successResponse":true
}

错误码

访问错误中心查看更多错误码。