文档首页/ 组织 Organizations/ API参考/ API/ 组织管理/ 列出组织的根
更新时间：2024-10-21 GMT+08:00
查看PDF
分享

列出组织的根

功能介绍

列出当前组织的根。此接口只能由组织的管理账号或作为服务委托管理员的成员账号调用。

调试

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

URI

GET https://{endpoint}/v1/organizations/roots

表1 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

页面中最大结果数量。

marker

否

String

分页标记。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Security-Token

否

String

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

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

roots

Array of RootDto objects

在组织中定义的根列表。

page_info

PageInfoDto object

分页信息
表4 RootDto

参数

参数类型

描述

id

String

根的唯一标识符（ID）。

urn

String

根的统一资源名称。

name

String

根的名称。

policy_types

Array of PolicyTypeSummaryDto objects

策略类型在当前根已启用，则该类型策略可以绑定到根或其组织单元或账号。

created_at

String

根的创建时间。
表5 PolicyTypeSummaryDto

参数

参数类型

描述

status

String

与根关联的策略类型状态。要将指定类型的策略绑定到根或该根中的组织单元或账号，该策略必须在组织中可用，并在该根已启用。enabled：启用；pending_enable：启用中；disabled：禁用；pending_disable：禁用中。

type

String

策略类型的名称，service_control_policy：服务控制策略；tag_policy：标签策略。
表6 PageInfoDto

参数

参数类型

描述

next_marker

String

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

current_count

Integer

本页返回条目数量

请求示例

列出组织的根

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.

错误码

请参见错误码。

父主题： 组织管理