跳到主要内容

查询域级收信黑白名单

GET/v2/messageRules/allowBlockLists

查询当前组织的域级收信黑白名单条目。通过 type 指定白名单或黑名单，并使用分页参数控制返回范围。

Request​

Query parameters

    type enum

    Possible values: [ALLOW, BLOCK]

    • ALLOW:
    • BLOCK:
    keyword string

    关键词过滤，支持按邮件地址、域名、IP 地址模糊搜索

响应

    entities object[]

    黑白名单条目列表

    id string

    条目唯一标识，只读

    type enum

    条目类型

    • EMAIL: 邮件地址
    • DOMAIN_NAME: 域名
    • IPV4ADDRESS: IPv4 地址
    • IPV4ADDRESSRANGE: IPv4 地址范围
    • IPV6ADDRESS: IPv6 地址
    • IPV6ADDRESSRANGE: IPv6 地址范围
    • IPREGION: IP 归属地区域

    Possible values: [EMAIL, DOMAIN_NAME, IPV4ADDRESS, IPV4ADDRESSRANGE, IPV6ADDRESS, IPV6ADDRESSRANGE, IPREGION]

    email string

    邮件地址，type 为 EMAIL 时必填

    domain string

    域名，type 为 DOMAIN_NAME 时必填

    ipAddress string

    IP 地址，type 为 IPV4ADDRESS 时填写如 "192.168.1.1"，type 为 IPV6ADDRESS 时填写如 "2001:db8::1"

    ipAddressRange object

    IP 地址范围，type 为 IPV4ADDRESSRANGE 或 IPV6ADDRESSRANGE 时必填

    begin string

    IP 范围起始地址，如 "192.168.1.1" 或 "2001:db8::1"

    end string

    IP 范围结束地址，如 "192.168.1.255" 或 "2001:db8::ffff"

    ipRegion object

    IP 归属地区域，type 为 IPREGION 时必填

    countryCode string

    国家代码，如 CN

    provinceCode string

    省份代码

    cityCode string

    城市代码

错误

401

访问未授权，请检查是否传递了正确的授权token

403

无API访问权限，请在域管的应用管理页面完成相关授权