有奖捉虫:行业应用 & 管理与支持文档专题 HOT

1. 接口描述

接口请求域名: eiam.tencentcloudapi.com 。

根据机构节点ID读取机构节点信息

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeOrgNode。
Version String 公共参数,本接口取值:2021-04-20。
Region String 公共参数,本接口不需要传递此参数。
OrgNodeId String 机构节点ID,是机构节点全局唯一标识,长度限制:64个字符。如果为空默认读取机构根节点信息。
IncludeOrgNodeChildInfo Boolean 是否读取其子节点信息。当其为空或false时,默认仅读取当前机构节点信息。当其为true时,读取本机构节点以及其第一层子节点信息。

3. 输出参数

参数名称 类型 描述
DisplayName String 机构节点展示名称,长度限制:64个字符。 默认与机构名相同。
注意:此字段可能返回 null,表示取不到有效值。
LastModifiedDate String 机构节点最后修改时间,符合 ISO8601 标准。
注意:此字段可能返回 null,表示取不到有效值。
CustomizedOrgNodeId String 机构节点外部ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:id
ParentOrgNodeId String 当前机构节点的父节点ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:id
OrgNodeId String 机构节点ID,是机构节点的全局唯一标识。
注意:此字段可能返回 null,表示取不到有效值。
示例值:id
DataSource String 数据来源。
注意:此字段可能返回 null,表示取不到有效值。
CreatedDate String 机构节点创建时间,符合 ISO8601 标准。
注意:此字段可能返回 null,表示取不到有效值。
OrgNodeChildInfo Array of OrgNodeChildInfo 当前机构节点下的子节点列表。
注意:此字段可能返回 null,表示取不到有效值。
Description String 机构节点描述。
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

输入示例

POST / HTTP/1.1
Host: eiam.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeOrgNode
<公共请求参数>

{
    "OrgNodeId": "7999987a-c9dc-4dd2-b3e2-b52f53317aa6",
    "IncludeOrgNodeChildInfo": "true"
}

输出示例

{
    "Response": {
        "LastModifiedDate": "2021-03-19T10:24:56.091+00:00",
        "RequestId": "b3040fd6-bb8f-438f-bb4a-adf25e373795",
        "ParentOrgNodeId": "94103aaa-79e2-49ee-a9cc-5aa90b30c2e5",
        "DisplayName": "字符串",
        "CreatedDate": "2021-03-19T10:23:29.104+00:00",
        "CustomizedOrgNodeId": "BB1",
        "OrgNodeId": "7999987a-c9dc-4dd2-b3e2-b52f53317aa6",
        "OrgNodeChildInfo": null,
        "Description": "测试机构",
        "DataSource": null
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.DescribeOrgNodeError 读取机构节点信息失败。
FailedOperation.DescribeOrgNodeRootError 读取根机构节点信息失败。
FailedOperation.OperationError 操作失败。
FailedOperation.OrgNodeIdNotExist 机构节点ID不存在。
InvalidParameterValue.ParameterIllegal 参数不合法。