# 列出组织的根 - ListRoots #### 功能介绍 列出当前组织的根。此接口只能由组织的管理账号或作为服务委托管理员的成员账号调用。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Organizations/doc?api=ListRoots)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-organizations/org_04_0030.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | organizations:roots:list | List | - | - | - | - | #### URI GET /v1/organizations/roots 表1Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | **参数解释**： 页面中最大结果数量。 **约束限制**： 不涉及 **取值范围**： 最小值1、最大值2000。 **默认取值**： 200 | | marker | 否 | String | **参数解释**： 分页标记。从上次查询响应的next_marker字段获取，首次查询不传此参数。 **约束限制**： 不涉及 **取值范围**： 符合正则表达式：\^\[A-Za-z0-9+/=_.-\]+$ 最小长度4、最大长度400。 **默认取值**： 不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Security-Token | 否 | String | **参数解释**： 如果正在使用临时安全凭据，则此 header 是必需的，该值是临时安全凭据的安全令牌（会话令牌）。通过IAM服务的获取临时访问密钥接口获取临时安全凭据。 **约束限制**： 不涉及 **取值范围**： 不涉及字符类型限制。 最小长度0、最大长度32768。 **默认取值**： 不涉及 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | roots | Array of [RootDto] objects | **参数解释**： 在组织中定义的根列表。数组内元素为RootDto对象，包含根的详细信息。 | | page_info | [PageInfoDto] object | **参数解释**： 分页信息。 **取值范围**： 不涉及 | 表4RootDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 根的唯一标识符（ID）。 **取值范围**： 符合正则表达式：\^r-\[0-9a-z\]{4,32}$ 最小长度6、最大长度34。 | | urn | String | **参数解释**： 根的统一资源名称。 **取值范围**： 符合URN格式，由英文字母、数字、冒号（:）、连字符（-）、正斜杠（/）等组成。 最小长度1、最大长度1500。 | | name | String | **参数解释**： 根的名称。 **取值范围**： 符合正则表达式：\^\[a-zA-Z\]\[0-9a-zA-Z_-\]+$ 最小长度2、最大长度64。 | | policy_types | Array of [PolicyTypeSummaryDto] objects | **参数解释**： 策略类型在当前根已启用，则该类型策略可以绑定到根或其组织单元或账号。数组内元素为PolicyTypeSummaryDto对象，包含策略类型详细信息。 | | created_at | String | **参数解释**： 根的创建时间。UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ，如2022-08-24T06:31:46Z。 **取值范围**： 不涉及。 | 表5PolicyTypeSummaryDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | status | String | **参数解释**： 与根关联的策略类型状态。要将指定类型的策略绑定到根或该根中的组织单元或账号，该策略必须在组织中可用，并在该根已启用。 **取值范围**： - enabled：启用 - pending_enable：启用中 - disabled：禁用 - pending_disable：禁用中 | | type | String | **参数解释**： 策略类型的名称。 **取值范围**： - service_control_policy：服务控制策略 - tag_policy：标签策略 | 表6PageInfoDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | next_marker | String | **参数解释**： 如果存在，则表示可用的输出比当前响应中包含的输出多。在对操作的后续调用中，在marker请求参数中使用此值，以获取输出的下一部分。您应该重复此操作，直到next_marker 响应元素返回为null。 **取值范围**： 符合正则表达式：\^\[A-Za-z0-9+/=_-\]+$。最小长度4、最大长度400。 | | current_count | Integer | **参数解释**： 本页返回条目数量。 **取值范围**： 最小值1、最大值2000。 | #### 请求示例 列出组织的根 ``` GET https://{endpoint}/v1/organizations/roots ``` #### 响应示例 **状态码：200** Successful. ``` { "roots" : [ { "id" : "r-rpjghpbmumu2hffplsj5edt1z3vybb94", "urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:root:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/r-rpjghpbmumu2hffplsj5edt1z3vybb94", "name" : "root", "policy_types" : [ { "status" : "enabled", "type" : "service_control_policy" } ], "created_at" : "2022-08-24T06:31:46Z" } ], "page_info" : { "next_marker" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw", "current_count" : 100 } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | Successful. | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-organizations/ErrorCode.html)。