使用 ListCustomers API 设置客户过滤条件

如果您需要查找特定客户的相关信息,可以通过 customers.list 方法使用 Cloud Channel API filter 参数。

如果您使用过滤器,则在创建客户的过程中,会出现短暂的延迟(通常为几秒钟)。如果您在创建后立即需要访问客户,建议您使用不带过滤条件的 customers.listcustomers.get

可用的过滤条件

过滤器参数的字符串支持完全匹配或完全匹配加前缀过滤。过滤条件不区分大小写。

下表介绍了您可以搜索的可用字段及其支持的方法。

外部搜索键 完全匹配支持 支持的前缀
网域
org_display_name
cloud_identity_id
channel_partner_id

您可以在 API 过滤指南中找到完整的过滤条件语法。

完全匹配语法

完全匹配过滤条件仅查找所含字段与所提交字符串中的客户相同的客户。

语法:<domain | org_display_name | cloud_identity_id | channel_partner_id> = <value>

示例:domain = "domain.com" AND channel_partner_id = "12345"

前缀语法

前缀过滤器允许将星号用作通配符。此过滤器将查找具有具有前缀的字段的客户,无论其后面包含什么内容。

语法:<domain | org_display_name> : <value>*

示例:domain : "uw.com*" AND org_display_name : "prefix*"

包含逻辑运算符的过滤条件示例

Cloud Channel API 过滤条件支持使用 AND 和 OR 逻辑运算符。通过用括号括起来的语句,您可以在一个过滤条件中使用两个运算符。

AND 示例

domain = "domain.com" AND channel_partner_id = "12345" AND org_display_name : "display*"

OR 示例

domain = "domain.com" OR channel_partner_id = "12345" OR org_display_name : "display*"

AND + OR 示例

domain = "domain.com" OR (channel_partner_id = "12345" AND org_display_name : "display*" )

如果过滤器包含 AND 和 OR 语句,则需要使用括号。 以下示例不是有效的过滤条件字符串。

domain = "domain.com" OR channel_partner_id = "12345" AND org_display_name : "display*