文档首页 > > API参考> 管理企业> 管理企业多账号> 查询企业子账号列表

查询企业子账号列表

分享
更新时间: 2019/09/20 GMT+08:00

功能介绍

企业主账号在客户自建平台查询企业子账号信息列表。

注意事项:

该接口只允许使用企业主账号AK/SK或者Token调用。

URI

GET /v1.0/{domain_id}/customer/customer-mgr/enterprise-customers

参数说明请参见下表。

表1 路径参数

参数

是否必选

取值范围

描述

domain_id

最大长度:64

客户账号ID,只能使用企业主账号。

获取方法请参见如何获取customer_id/domain_id

表2 查询参数

参数

是否必选

参数类型

取值范围

描述

sub_customer_name

String

最大长度:64

企业子账号的账号名。

根据fuzzy_query取值决定是否按模糊查询。

display_name

String

最大长度:64

企业子账号的显示名称。

  • 不限制特殊字符。
  • 根据fuzzy_query取值决定是否按模糊查询。

fuzzy_query

Integer

[0,1]

企业子账号的显示名称、用户名是否按模糊查询。

  • 0:不按模糊查询。
  • 1:按模糊查询。

offset

Integer

[1-200000]

页码(默认1)。

limit

Integer

[1-100]

每页记录数(默认10)。

请求消息

请求参数

无。

请求示例

GET /v1.0/{domain_id}/customer/customer-mgr/enterprise-customers?offset=1&limit=10&sub_customer_name=ssj_jt1&display_name=&fuzzy_query=1
Host: Host Server
Content-Type: application/json
X-Sdk-Date: request time
Authorization: authorization

响应消息

响应参数

参数

是否必选

参数类型

取值范围

描述

error_code

String

最大长度:16

状态码。具体请参考状态码。只有失败才会返回这个参数。

error_msg

String

最大长度:1024

错误描述信息。只有失败才会返回这个参数。

subCustomerInfos

List<SubCustomerInfo>

-

客户信息列表,成功才有。

具体请参见表3

totalCount

Long

-

结果集数量,成功才有。

表3 SubCustomerInfo

参数

是否必选

参数类型

取值范围

描述

subCustomerId

String

最大长度:64

企业子账号的客户ID。

subCustomerName

String

最大长度:64

企业子账号的用户名。

displayName

String

最大长度:64

企业子账号的显示名称。

不限制特殊字符。

status

Integer

[1,2,3,4,101,102]

子账号状态:

1:正常;

2:创建中;

3:关闭中;

4:已关闭;

101:子账号注册中;

102:子账号待激活。

响应示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time  

{
    "totalCount": 1,
    "subCustomerInfos": [
        {
            "subCustomerId": "c28cc893e9054c139ddf9ccfc6257825",
            "subCustomerName": "ssj_jt1",
            "displayName": null,
            "status": 1
        }
    ]
}

状态码

HTTP状态码

错误码

错误描述

400

CBC.0100

输入参数校验失败。

403

CBC.0151

访问拒绝。

500

CBC.0999

其他错误。

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区