文档首页/ 云防火墙 CFW/ API参考/ API/ 多账号管理/ 查询组织结构
更新时间：2025-08-12 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询组织结构

功能介绍

查询组织结构

调用方法

请参见如何调用API。

URI

GET /v1/{project_id}/system/multi-account/organization-tree

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以从调API处获取，也可以从控制台获取。项目ID获取方式

约束限制：

不涉及

取值范围：

32位UUID

默认取值：

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

fw_instance_id

是

String

参数解释：

防火墙ID，用户创建防火墙实例后产生的唯一ID，配置后可区分不同防火墙，可通过防火墙ID获取方式获取

约束限制：

不涉及

取值范围：

32位UUID

默认取值：

不涉及

parent_id

否

String

参数解释：

父节点（根或组织单元）的唯一标识符（ID）

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

limit

否

Integer

参数解释：

查询返回记录的数量限制

约束限制：

不涉及

取值范围：

1-2000

默认取值：

2000

marker

否

String

参数解释：

分页标记

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

data

Array of OrganizationAccountInfo objects

参数解释：

查询组织账号响应

取值范围：

不涉及

marker

String

参数解释：

分页标记

取值范围：

不涉及

total

Integer

参数解释：

总数

取值范围：

不涉及
表4 OrganizationAccountInfo

参数

参数类型

描述

delegated

Boolean

参数解释：

是否已添加

取值范围：

不涉及

id

String

参数解释：

账号的唯一标识符

取值范围：

不涉及

name

String

参数解释：

账号名称

取值范围：

不涉及

org_type

String

参数解释：

组织节点类型

取值范围：

account

parent_id

String

参数解释：

父节点（根或组织单元）的唯一标识符（ID）

取值范围：

不涉及

urn

String

参数解释：

账号的统一资源名称

取值范围：

不涉及

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码

取值范围：

不涉及

error_msg

String

参数解释：

错误描述

取值范围：

不涉及

请求示例

查询组织结构，项目ID为176d761dc156471c9c9b227376594160，防火墙ID为ea0e700f-7ae6-47c1-a8d0-ed4b1acd8e8e，组织单元ID为ou-xuyegm9ace9gqucy2sdlw821r22s2xo0

https://{Endpoint}/v1/176d761dc156471c9c9b227376594160/system/multi-account/organization-tree?fw_instance_id=ea0e700f-7ae6-47c1-a8d0-ed4b1acd8e8e&parent_id=ou-xuyegm9ace9gqucy2sdlw821r22s2xo0

响应示例

状态码：200

OK

{
  "data" : [ {
    "delegated" : false,
    "id" : "ou-5685cxqjfngoh898df28jm736x4ugvb2",
    "name" : "test1",
    "org_type" : "unit",
    "parent_id" : "ou-xuyegm9ace9gqucy2sdlw821r22s2xo0",
    "urn" : "organizations::52d4c977dc834434920af54060d74af4:ou:o-r0b4bh2jcr1ke7yn70uhwlp5d0ktwisb/ou-5685cxqjfngoh898df28jm736x4ugvb2"
  } ],
  "total" : 1
}

状态码：400

Bad Request

{
  "error_code" : "CFW.00200003",
  "error_msg" : "参数错误"
}

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码。

父主题： 多账号管理