文档中心

云数据库 PostgreSQL 版

数据安全

DescribeAllowLists

DescribeAllowLists

调用 DescribeAllowLists 接口查看指定地域下的白名单列表。

请求类型

同步请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

请求参数

参数	类型	是否必选	示例值	描述
RegionId	String	是	cn-beijing	地域 ID，可调用 DescribeRegions 接口查询。
InstanceId	String	否	postgres-sdasd***	实例 ID。说明如不设定该字段，返回当前地域下的所有白名单。如设定该字段，则返回该实例的所有白名单。
AllowListCategory	String	否	Default	白名单分类。取值： Ordinary：普通白名单。 Default：默认白名单。说明该参数作为请求参数时无默认值，不传入时则查询所有类别的白名单。
AllowListDesc	String	否	这是一段白名单的描述信息。	白名单的描述信息。可通过描述信息进行模糊搜索。
AllowListId	String	否	acl-fe1339b0024e42ca9872e8f4af12****	白名单 ID。
AllowListName	String	否	Test_Allowlist	白名单的名称。
IPAddress	String	否	"2.2.2.2,1.1.1.1"	按 IP 地址查询白名单。支持传入多个 IP 地址，多个 IP 地址使用英文逗号（,）分隔。说明如果白名单包含了多个 IP 地址的任意子集，该白名单就会被返回。
PageNumber	Long	否	2	当前页页码。取值最小为 1。默认值为 1。
PageSize	Long	否	20	每页记录数。取值最小为 1，且不超过 Integer 的最大值。无默认值。

返回参数

参数	类型	示例值	描述
AllowLists	Array of AllowListObject	请参见返回示例。	白名单信息。
Total	Long	20	白名单的总数。

AllowListObject

参数	类型	示例值	描述
AllowListDesc	String	这是一段白名单的描述信息。	白名单的描述信息。
AllowListIPNum	Integer	2	白名单中 IP 地址或 IP 地址段的数量。
AllowListId	String	acl-fe1339b0024e42ca9872e8f4af12****	白名单的 ID。
AllowListName	String	这是一个白名单名称	白名单的名称。
AllowListType	String	IPv4	白名单采用的网络协议类型。取值为 IPv4。
AssociatedInstanceNum	Integer	3	白名单绑定的实例数量。
AllowListCategory	String	Default	白名单分类。取值： Ordinary：普通白名单。 Default：默认白名单。说明该参数作为请求参数时无默认值，不传入时则查询所有类别的白名单。
SecurityGroupBindInfos	Array of SecurityGroupBindInfo	请参见返回示例。	白名单绑定的安全组的信息。如白名单未绑定安全组，则返回 null。

SecurityGroupBindInfo

参数	类型	示例值	描述
IpList	Array of String	["10...1/32","10...2/32"]	安全组中的 IP。
BindMode	String	IngressDirectionIp	关联安全组的模式。取值： IngressDirectionIp：入方向 IP。 AssociateEcsIp：关联 ECSIP。
SecurityGroupId	String	sg-b8pzuwk3i4g028j06k8f****	安全组 ID。
SecurityGroupName	String	测试安全组	安全组名称。

示例

请求示例

返回示例

最近更新时间：2026.03.31 10:39:11

这个页面对您有帮助吗？

有用

有用

无用

无用