文档首页> 组织 Organizations> API参考> API> 其他> 列出组织中的根、组织单元和账号
更新时间：2024-05-11 GMT+08:00
查看PDF

列出组织中的根、组织单元和账号

功能介绍

列出组织中包含的所有根、组织单元和账号。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。您可以通过指定父ID和子ID参数来过滤实体。

URI

GET /v1/organizations/entities

表1 Query参数

参数

是否必选

参数类型

描述

parent_id

否

String

父节点（根或组织单元）的唯一标识符（ID）。

最大长度：100

child_id

否

String

子节点（组织单元）的唯一标识符（ID）。

最大长度：100

limit

否

Integer

页面中最大结果数量。

最小值：1

最大值：2000

缺省值：200

marker

否

String

分页标记。

最小长度：4

最大长度：400

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Security-Token

否

String

如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。

最小值：1

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

entities

Array of EntityDto objects

组织中的根、组织单元和账号的列表。

page_info

PageInfoDto object

分页信息
表4 EntityDto

参数

参数类型

描述

name

String

实体的名称。

最小长度：1

最大长度：64

id

String

实体的唯一标识符（ID）。

最大长度：100

type

String

实体的类型。account：账号；organizational_unit：组织单元；root：根。

最小长度：1

最大长度：64
表5 PageInfoDto

参数

参数类型

描述

next_marker

String

如果存在，则表示可用的输出比当前响应中包含的输出多。在对操作的后续调用中，在标签请求参数中使用此值，以获取输出的下一部分。您应该重复此操作，直到next_marker响应元素返回为null。

current_count

Integer

本页返回条目数量

最小值：1

最大值：2000

请求示例

列出组织中的根、组织单元和账号

GET https://{hostname}/v1/organizations/entities

响应示例

状态码： 200

Successful

{
  "entities" : [ {
    "name" : ">Xm0g]]sW9KS2]kJ<bToX>1wu?S-?63MH]Of^D8CwZn\\L2qak7nd<h5IkFlp^Nc5",
    "id" : "r-1ipjropk1htpbwsd9v06faef6ls48o",
    "type" : "account"
  } ],
  "page_info" : {
    "next_marker" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw",
    "current_count" : 100
  }
}

状态码

状态码

描述

200

Successful

错误码

请参见错误码。

父主题： 其他