查询账号组织 - ListOrganizationTree
功能介绍
查询账号组织
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v5/setting/account/organization-tree
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
is_refresh |
否 |
Boolean |
是否强制从organization同步组织信息 |
|
enterprise_project_id |
否 |
String |
主机所属的企业项目ID。 开通企业项目功能后才需要配置企业项目。 企业项目ID默认取值为“0”，表示默认企业项目。如果需要查询所有企业项目下的主机，请传参“all_granted_eps”。如果您只有某个企业项目的权限，则需要传递该企业项目ID，查询该企业项目下的主机，否则会因权限不足而报错。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Security-Token |
否 |
String |
如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。 |
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） |
|
region |
否 |
String |
Region ID |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-request-id |
String |
用于任务跟踪的请求ID号。格式为request_uuid-timestamp-hostname。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Integer |
参数解释: 总数 取值范围: 最小值0，最大值2147483647 |
|
data_list |
Array of OrganizationNodeResponseInfo objects |
事件列表详情 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
parent_id |
String |
父节点Id |
|
id |
String |
节点Id |
|
urn |
String |
组织的统一资源名称，格式：organizations::{management_account_id}:xxxxx:{org_id}/xxxxxxxx。 |
|
name |
String |
名称 |
|
org_type |
String |
参数解释: 节点类型 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
delegated |
Boolean |
组织或账号是否已授权。
|
请求示例
查询根目录下所有账号组织，不强制从organization同步组织信息
GET https://{endpoint}/v5/setting/account/organization-tree?is_refresh=false&parent_id=root&enterprise_project_id=all_granted_eps
响应示例
状态码：200
请求已成功
{
"data_list" : [ {
"parent_id" : "r-32rp34usb1n12d2sdk2cv2w7igod0lud",
"id" : "6a321faa6e6c4a18b5bf19dd954377b5",
"urn" : "organizations::6e5b687e10224a18af014e5d81bf9b3c:account:o-jbg8sokerqszi0zdo6vvaulwdsenonxz/6a321faa6e6c4a18b5bf19dd954377b5",
"name" : "scc_test",
"org_type" : "account",
"delegated" : true
} ],
"total_num" : 1
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。
