列出组织单元 - ListOrganizationalUnits
功能介绍
列出组织中的所有组织单元。如果指定父级组织单元,则将获得父级直系子级的组织单元列表。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
organizations:ous:list
List
-
-
-
-
URI
GET /v1/organizations/organizational-units
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
parent_id |
否 |
String |
父节点(根或组织单元)的唯一标识符(ID)。 |
|
limit |
否 |
Integer |
页面中最大结果数量。当未指定Limit参数情况下,系统默认值为1000。 |
|
marker |
否 |
String |
分页标记。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Security-Token |
否 |
String |
如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
organizational_units |
Array of OrganizationalUnitDto objects |
组织单元列表。 |
|
page_info |
PageInfoDto object |
分页信息 |
请求示例
列出组织单元
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
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Successful |
错误码
请参见错误码。