列出组织单元 - ListOrganizationalUnits

功能介绍

列出组织中的所有组织单元。如果指定父级组织单元，则将获得父级直系子级的组织单元列表。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

organizations:ous:list

List

-

-

-

-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
organizations:ous:list	List	-	-	-	-

URI

GET /v1/organizations/organizational-units

表1 Query参数
参数	是否必选	参数类型	描述
parent_id	否	String	参数解释：父节点（根或组织单元）的唯一标识符（ID）。约束限制：不涉及取值范围：符合正则表达式：^(?:r-[0-9a-z]{4,32}\|ou-[0-9a-z]{8,32})$ 最大长度100。默认取值：无默认值
limit	否	Integer	参数解释：页面中最大结果数量。当未指定 Limit 参数情况下，系统默认值为 1000。约束限制：不涉及取值范围：最小值1、最大值2000。默认取值： 200
marker	否	String	参数解释：分页标记。约束限制：不涉及取值范围：符合正则表达式：^[A-Za-z0-9+/=-_.]+$ 最小长度4、最大长度400。默认取值：无默认值

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Security-Token	否	String	参数解释：如果正在使用临时安全凭据，则此 header 是必需的，该值是临时安全凭据的安全令牌（会话令牌）。约束限制：不涉及取值范围：最小长度0、最大长度32768。默认取值：无默认值

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
organizational_units	Array of OrganizationalUnitDto objects	参数解释：组织单元列表。约束限制：必填字段取值范围：不涉及默认取值：无默认值
page_info	PageInfoDto object	参数解释：分页信息。约束限制：不涉及取值范围：不涉及默认取值：无默认值

表4 OrganizationalUnitDto
参数	参数类型	描述
id	String	参数解释：与组织单元关联的唯一标识符（ID）。约束限制：必填字段取值范围：符合正则表达式：^ou-[0-9a-z]{8,32}$ 最小长度1、最大长度35。默认取值：无默认值
urn	String	参数解释：组织单元的统一资源名称。约束限制：必填字段取值范围：最小长度1、最大长度1500。默认取值：无默认值
name	String	参数解释：组织单元的名称。约束限制：必填字段取值范围：符合正则表达式：^[\u4e00-\u9fa5a-zA-Z0-9_- ]+$ 最小长度1、最大长度64。默认取值：无默认值
created_at	String	参数解释：组织单元的创建时间。约束限制：必填字段取值范围：符合ISO 8601日期时间格式。默认取值：无默认值

表5 PageInfoDto
参数	参数类型	描述
next_marker	String	参数解释：如果存在，则表示可用的输出比当前响应中包含的输出多。在对操作的后续调用中，在标签请求参数中使用此值，以获取输出的下一部分。您应该重复此操作，直到next_marker 响应元素返回为null。约束限制：必填字段取值范围：符合正则表达式：^[A-Za-z0-9+/=-_]+$ 默认取值：无默认值
current_count	Integer	参数解释：本页返回条目数量。约束限制：不涉及取值范围：最小值1、最大值2000。默认取值：无默认值

请求示例

列出组织单元

GET https://{endpoint}/v1/organizations/organizational-units

响应示例

状态码：200

Successful

{
  "organizational_units" : [ {
    "id" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw",
    "urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:ou:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw",
    "name" : "autoOU0923152729270Pkgk",
    "created_at" : "2022-09-23T07:27:28Z"
  } ],
  "page_info" : {
    "next_marker" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw",
    "current_count" : 100
  }
}