# 查询企业子账号列表-ListEnterpriseSubCustomers #### 功能介绍 企业主账号在自建平台查询企业子账号信息列表。 #### 接口约束 该接口只允许使用企业主账号AK/SK或者Token调用。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=BSS&api=ListEnterpriseSubCustomers)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[策略授权参考](https://support.huaweicloud.com/api-oce/jac_000053.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 描述 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | |:---|:---|:---|:---|:---|:---| | businessUnitCenter:businessUnit:view | 授予查看组织与账号的权限 | read | - | - | - | #### URI GET /v2/enterprises/multi-accounts/sub-customers 参数说明请参见下表。 表1查询参数 | 参数 | 是否必选 | 参数类型 | 取值范围 | 描述 | |:---|:---|:---|:---|:---| | sub_customer_account_name | 否 | String | 最大长度：64 | 企业子账号的账号名。 根据fuzzy_query取值决定是否按模糊查询。仅支持前缀匹配、后缀匹配、中间匹配；不支持携带空格查询。 此参数不携带或携带值为空时，不作为筛选条件；携带值为空串时，作为筛选条件。 | | sub_customer_display_name | 否 | String | 最大长度：64 | 企业子账号的显示名称。 - 根据fuzzy_query取值决定是否按模糊查询。仅支持前缀匹配、后缀匹配、中间匹配；不支持携带空格查询。 说明： 如果包含中文或者特殊字符，请使用encodeURIComponent进行编码处理。 此参数不携带或携带值为空时，不作为筛选条件；携带值为空串时，作为筛选条件。 | | fuzzy_query | 否 | Integer | - | 企业子账号的显示名称、用户名是否按模糊查询。默认值为"0：不按模糊查询"。 - 0：不按模糊查询 - 1：按模糊查询 | | offset | 否 | Integer | \[0-最大整数\] | 偏移量，从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 | \[1-100\] | 每次查询记录数，默认值为10。 | | org_id | 否 | String | 最大长度：20 | 子账号归属的组织单元ID。 此参数不携带或携带值为空时，不作为筛选条件。 | #### 请求消息 **请求参数** 无。 **请求示例** ``` GET https://bss.myhuaweicloud.com/v2/enterprises/multi-accounts/sub-customers?offset=0&limit=10&sub_customer_account_name=d_2035&sub_customer_display_name=m&fuzzy_query=1&org_id=65419 HTTP/1.1 Content-Type: application/json X-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ ``` #### 响应消息 **响应参数** | 参数 | 参数类型 | 取值范围 | 描述 | |:---|:---|:---|:---| | error_code | String | 最大长度：16 | 状态码。具体请参考[状态码]。只有失败才会返回这个参数。 | | error_msg | String | 最大长度：1024 | 错误描述信息。只有失败才会返回这个参数。 | | sub_customer_infos | List\ | - | 客户信息列表，成功才有。 具体请参见[表2]。 | | total_count | Integer | - | 结果集数量，成功才有。 | 表2SubCustomerInfoV2 | 参数 | 参数类型 | 取值范围 | 描述 | |:---|:---|:---|:---| | id | String | 最大长度：64 | 企业子账号的客户ID。 | | name | String | 最大长度：64 | 企业子账号的用户名。 | | display_name | String | 最大长度：64 | 企业子账号的显示名称。 不限制特殊字符。 | | status | Integer | - | 子账号状态： - 1：正常 - 2：创建中 - 3：关闭中 - 4：已关闭 - 101：子账号注册中 - 102：子账号待激活 | | org_id | String | 最大长度：20 | 子账号归属的组织单元ID。 | | org_name | String | 最大长度：64 | 子账号归属的组织单元名称。 说明： 当子账号归属的组织是企业组织根节点时，本属性可能为空。 | **响应示例** ``` HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Content-Length: length Date: response time { "total_count": 1, "sub_customer_infos": [ { "id": "4C2DC9********2F8F890E654589C2F7", "name": "A8****F112", "display_name": "A8****F112", "status": 1, "org_id": "65419", "org_name": "一级组织" } ] } ``` #### 状态码 ![](https://support.huaweicloud.com/api-oce/public_sys-resources/note_3.0-zh-cn.png) - 状态码4xx：由于明显的客户端错误（例如，格式错误的请求语法、参数错误等），华为云会返回4xx错误码，请及时检查请求消息的正确性，重新发起请求。 - 状态码5xx：由于华为云系统原因，导致无法完成明显有效请求的处理，可及时联系华为云客服处理。 | HTTP状态码 | 错误码 | 错误描述 | |:---|:---|:---| | 400 | CBC.0100 | 参数错误。 | | 403 | CBC.0151 | 访问拒绝。 | | 500 | CBC.0999 | 其他错误。 |