查询组织结构
功能介绍
查询组织结构
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/system/multi-account/organization-tree
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以从调API处获取,也可以从控制台获取。项目ID获取方式 约束限制: 不涉及 取值范围: 32位UUID 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
fw_instance_id |
是 |
String |
参数解释: 防火墙ID,用户创建防火墙实例后产生的唯一ID,配置后可区分不同防火墙,可通过防火墙ID获取方式获取 约束限制: 不涉及 取值范围: 32位UUID 默认取值: 不涉及 |
parent_id |
否 |
String |
参数解释: 父节点(根或组织单元)的唯一标识符(ID) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
limit |
否 |
Integer |
参数解释: 查询返回记录的数量限制 约束限制: 不涉及 取值范围: 1-2000 默认取值: 2000 |
marker |
否 |
String |
参数解释: 分页标记 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
无
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
data |
Array of OrganizationAccountInfo objects |
参数解释: 查询组织账号响应 取值范围: 不涉及 |
marker |
String |
参数解释: 分页标记 取值范围: 不涉及 |
total |
Integer |
参数解释: 总数 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
delegated |
Boolean |
参数解释: 是否已添加 取值范围: 不涉及 |
id |
String |
参数解释: 账号的唯一标识符 取值范围: 不涉及 |
name |
String |
参数解释: 账号名称 取值范围: 不涉及 |
org_type |
String |
参数解释: 组织节点类型 取值范围: account |
parent_id |
String |
参数解释: 父节点(根或组织单元)的唯一标识符(ID) 取值范围: 不涉及 |
urn |
String |
参数解释: 账号的统一资源名称 取值范围: 不涉及 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
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" : "参数错误" }
SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.cfw.v1.region.CfwRegion; import com.huaweicloud.sdk.cfw.v1.*; import com.huaweicloud.sdk.cfw.v1.model.*; public class ListOrganizationTreeSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); CfwClient client = CfwClient.newBuilder() .withCredential(auth) .withRegion(CfwRegion.valueOf("<YOUR REGION>")) .build(); ListOrganizationTreeRequest request = new ListOrganizationTreeRequest(); try { ListOrganizationTreeResponse response = client.listOrganizationTree(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcfw.v1.region.cfw_region import CfwRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcfw.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = CfwClient.new_builder() \ .with_credentials(credentials) \ .with_region(CfwRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListOrganizationTreeRequest() response = client.list_organization_tree(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" cfw "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := cfw.NewCfwClient( cfw.CfwClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListOrganizationTreeRequest{} response, err := client.ListOrganizationTree(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
错误码
请参见错误码。