文档首页/ 客户运营能力/ API参考/ 待下线接口/ 管理企业/ 管理企业多账号/ 查询企业子账号列表（旧）
更新时间：2024-09-24 GMT+08:00
查看PDF
分享

查询企业子账号列表（旧）

功能介绍

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

注意事项：

该接口只允许使用企业主账号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取值决定是否按模糊查询。

此参数不携带或携带值为空时，不作为筛选条件；携带值为空串或携带值为null时，作为筛选条件。

display_name

否

String

最大长度：64

企业子账号的显示名称。

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

此参数不携带或携带值为空时，不作为筛选条件；携带值为空串或携带值为null时，作为筛选条件。

fuzzy_query

否

Integer

[0,1]

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

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

此参数不携带或携带值为空或携带值为null时，不作为筛选条件；不支持携带值为空串。

offset

否

Integer

[1-200000]

页码（默认1）。

此参数不携带或携带值为空或携带值为null时，取值为1；不支持携带值为空串。

limit

否

Integer

[1-100]

每页记录数（默认10）。

此参数不携带或携带值为空或携带值为null时，取值为10；不支持携带值为空串。

org_party_id

否

string

最大长度：20

子账号归属的组织单元ID。

此参数不携带或携带值为空时，不作为筛选条件；不支持携带值为空串或携带值为null。

请求消息

请求参数

无。

请求示例

GET https://bss.myhuaweicloud.com/v1.0/{domain_id}/customer/customer-mgr/enterprise-customers?offset=1&limit=10&sub_customer_name=ssj_jt1&display_name=&fuzzy_query=1 HTTP/1.1
Content-Type: application/json
X-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

响应消息

响应参数

参数

参数类型

取值范围

描述

error_code

String

最大长度：16

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

error_msg

String

最大长度：1024

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

subCustomerInfos

List<SubCustomerInfo>

-

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

具体请参见表3。

totalCount

Integer

-

结果集数量，成功才有。
表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：子账号待激活

orgPartyId

String

最大长度：20

子账号归属的组织单元ID

orgPartyName

String

最大长度：64

子账号归属的组织单元名称

注：当子账号归属的组织是企业组织根节点时，本属性可能为空。

响应示例

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

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

状态码

  • 状态码4xx：由于明显的客户端错误（例如，格式错误的请求语法、参数错误等），华为云会返回4xx错误码，请及时检查请求消息的正确性，重新发起请求。
  • 状态码5xx：由于华为云系统原因，导致无法完成明显有效请求的处理，可及时联系华为云客服处理。

HTTP状态码

错误码

错误描述

400

CBC.0100

参数错误。

403

CBC.0151

访问拒绝。

500

CBC.0999

其他错误。
父主题： 管理企业多账号

相关文档