# 查询客户列表-ListSubCustomers #### 功能介绍 伙伴可以查询合作伙伴的客户信息列表。 伙伴登录合作伙伴中心查询客户信息列表请参见[这里](https://support.huaweicloud.com/usermanual-bpconsole/zh-cn_topic_0072435115.html)。 #### 接口约束 接口只允许使用解决方案提供商或华为云总经销商（一级经销商）的AK/SK或者Token调用。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=BSS&api=ListSubCustomers)中调试该接口。 #### 授权信息 操作员账号调用当前API需经过授权，您可以通过伙伴中心为操作员赋予相应权限项来完成授权。有关如何为角色授权的详细信息，请参见[为组织人员分配权限](https://support.huaweicloud.com/usermanual-bpconsole/zh-cn_topic_0072435164.html)。 接口对应的权限项如下： | 权限项 | 权限项名称 | |:---|:---| | BPC_ITEM_SUBCUSTSERV_010100\|BPC_ITEM_SUBCUSTSERV_010500 | - 销售-客户-客户管理-客户列表-查看列表 - 销售-客户-客户管理-二级经销商子客户-查看客户信息 | #### URI POST /v2/partners/sub-customers/query #### 请求消息 请求参数 | 参数 | 是否必选 | 参数类型 | 取值范围 | 描述 | |:---|:---|:---|:---|:---| | account_name | 否 | String | 最大长度：64 | 客户登录名称（如果客户创建了IAM用户，此处需要填写主账号登录名称。关于主账号和IAM用户的具体介绍请参见[身份管理](https://support.huaweicloud.com/productdesc-iam/iam_01_0023.html)中"账号"和"IAM用户"的描述）。 支持模糊查询。仅支持前缀匹配、后缀匹配、中间匹配；不支持携带空格查询。 此参数不携带或携带值为空串或携带值为null时，不作为筛选条件。 | | customer | 否 | String | 最大长度：64 | 客户的实名认证名称，支持模糊查询。仅支持前缀匹配、后缀匹配、中间匹配；不支持携带空格查询。 此参数不携带或携带值为空串或携带值为null时，不作为筛选条件。 | | offset | 否 | Integer | \[0-40000000\] | 偏移量，从0开始。默认值为0。 说明： offset用于分页处理，如不涉及分页，请使用默认值0。offset表示相对于满足条件的第一个数据的偏移量。如offset = 1，则返回满足条件的第二个数据至最后一个数据。 示例1，满足查询条件的结果共10条数据，limit取值为10，offset取值为1，则返回的数据为2\~10，第一条数据不返回。 示例2，查询总数20条，期望每页返回10条数据，则获取第一页数据，入参offset填写0，limit填写10；获取第二页数据，入参offset填写10，limit填写10。 | | limit | 否 | Integer | 最大值：100 | 每次查询的客户数量。默认值为10。 | | label | 否 | String | 最大长度：64 | 标签，支持模糊查找。仅支持前缀匹配、后缀匹配、中间匹配；不支持携带空格查询；不支持英文大小写模糊匹配查询。 此参数不携带或携带值为空串或携带值为null时，不作为筛选条件。 | | association_type | 否 | String | 最大长度：2 | 关联类型： - 1：顾问销售 - 2：代售 此参数不携带或携带值为空串或携带值为null时，不作为筛选条件。 | | associated_on_begin | 否 | String | 最大长度：20 | 关联时间区间段开始，UTC时间。 格式：YYYY-MM-DD'T'hh:mm:ss'Z'，例如"2019-05-06T08:05:01Z"。 此参数不携带或携带值为null时，不作为筛选条件，不支持携带值为空串。 | | associated_on_end | 否 | String | 最大长度：20 | 关联时间区间段结束，UTC时间。 格式：YYYY-MM-DD'T'hh:mm:ss'Z'，例如"2019-05-06T08:05:01Z"。 此参数不携带或携带值为null时，不作为筛选条件，不支持携带值为空串。 | | customer_id | 否 | String | 最大长度：64 | 客户账号ID。您可以调用[查询客户列表-ListSubCustomers](https://support.huaweicloud.com/api-bpconsole/mc_00021.html)接口获取customer_id，或者可以从[创建客户](https://support.huaweicloud.com/api-bpconsole/mc_00016.html)接口的响应获取domain_id。 此参数不携带或携带值为空串或携带值为null时，不作为筛选条件。 | | indirect_partner_id | 否 | String | 最大长度：64 | 云经销商ID。获取方法请参见[查询云经销商列表-ListIndirectPartners](https://support.huaweicloud.com/api-bpconsole/espp_00003.html)。如果需要查询云经销商的子客户列表，必须携带该字段。除此之外，此参数不做处理。 | 请求示例 ``` POST https://bss.myhuaweicloud.com/v2/partners/sub-customers/query HTTP/1.1 Content-Type: application/json X-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ { "account_name": "betahc_kehu107", "customer": "sun***01", "offset": "0", "limit": "10", "label": "sunny", "association_type": "1", "associated_on_begin": "2019-05-06T08:05:01Z", "associated_on_end": "2019-05-06T08:05:01Z", "customer_id":"065024********e90f44c01cbccfa280", "indirect_partner_id": "si3fjg8ugf********" } ``` #### 响应消息 响应参数 | 参数 | 参数类型 | 取值范围 | 描述 | |:---|:---|:---|:---| | error_code | String | 最大长度：16 | 状态码。只有失败才会返回这个参数。 具体请参见[状态码]。 | | error_msg | String | 最大长度：1024 | 错误描述信息。只有失败才会返回这个参数。 | | customer_infos | List\ | - | 客户信息列表。 具体请参见[表1]。 | | count | Integer | - | 总记录数。 | 表1CustomerInfo | 参数 | 参数类型 | 取值范围 | 描述 | |:---|:---|:---|:---| | customer | String | 最大长度：128 | 实名认证名称。 | | account_name | String | 最大长度：128 | 客户登录名称（如果客户创建了子用户，此处返回主账号登录名称）。 | | customer_id | String | 最大长度：64 | 客户账号ID。 | | associated_on | String | 最大长度：20 | 客户和伙伴关联时间。 UTC时间，格式：yyyy-MM-dd'T'HH:mm:ss'Z'，如"2019-05-06T08:05:01Z"，其中，HH范围是0～23，mm和ss范围是0～59。 | | association_type | String | 最大长度：2 | 关联类型： - 1：顾问销售 - 2：代售 | | label | String | 最大长度：64 | 标签。 | | telephone | String | 最大长度：20 | 客户电话号码。 | | verified_status | String | 最大长度：5 | 实名认证状态： - -1：未实名认证 - 0：实名认证审核中 - 1：实名认证不通过 - 2：已实名认证 | | country_code | String | 最大长度：10 | 国家码，电话号码的国家码前缀。 例如：中国 0086。 | | customer_type | Integer | - | 客户类型： - -1：无类型 - 0：个人 - 1：企业 客户刚注册的时候，没有具体的客户类型，为"-1：无类型"，客户可以在账号中心通过设置客户类型或者在实名认证的时候，选择对应的企业/个人实名认证来决定自己的类型。 | | is_frozen | Integer | - | 是否冻结： - 0：否 - 1：客户账号冻结 - 2：客户账号和资源冻结 该字段预留。 | | account_managers | List\ | 最大个数：10 | 该客户对应的客户经理信息，目前只支持1个，具体参见[表2]。 | | xaccount_id | String | 最大长度：128 | 伙伴销售平台的用户唯一标识，该标识的具体值由伙伴分配。 | | xaccount_type | String | 最大长度：64 | 华为分配给合作伙伴的平台标识。 该标识的具体值由华为分配。获取方法请参见[如何获取xaccountType的取值](https://support.huaweicloud.com/api-bpconsole/bpconsole_apifaq_00002.html)。 | | customer_level | String | 最大长度：64 | 客户等级。具体等级体系和权益请参见[客户等级体系](https://www.huaweicloud.com/about/customer_tier.html)。 - V0 - V1 - V2 - V3 - V4 - V5 | | email | String | 最大长度：256 | 客户邮箱。 | 表2AccountManager | 参数 | 参数类型 | 取值范围 | 描述 | |:---|:---|:---|:---| | account_name | String | 最大长度：128 | 客户经理登录名称。 | 响应示例 ``` HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Content-Length: length Date: response time { "customer_infos": [ { "customer": "sun***01", "account_name": "betahc_kehu107", "customer_id": "0b11fa********870f20c003f6a53940", "associated_on": "2021-01-05T06:35:51Z", "association_type": "1", "label": "sunny", "telephone": "134****6666", "verified_status": "2", "country_code": "0086", "customer_type": "0", "is_frozen": "0", "account_managers": [ { "account_name": "tan_ma" } ], "xaccount_id": "98**9707", "xaccount_type": "***_IDP", "customer_level": "V0", "email":"***@163.com" } ], "count": "1" } ``` #### 状态码 ![](https://support.huaweicloud.com/api-bpconsole/public_sys-resources/note_3.0-zh-cn.png) - 状态码4xx：由于明显的客户端错误（例如，格式错误的请求语法、参数错误等），华为云会返回4xx错误码，请及时检查请求消息的正确性，重新发起请求。 - 状态码5xx：由于华为云系统原因，导致无法完成明显有效请求的处理，可及时联系华为云客服处理。 | HTTP状态码 | 错误码 | 描述 | |:---|:---|:---| | 400 | CBC.0100 | 参数错误。 | | 400 | CBC.99000037 | 您没有操作该云经销商的权限。 | | 401 | CBC.0154 | token非法/过期。 | | 403 | CBC.0151 | 访问拒绝。 | | 500 | CBC.0999 | 其他错误。 |