1. 接口描述
接口请求域名: eiam.tencentcloudapi.com 。
新建一个机构节点
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateOrgNode。 |
Version | 是 | String | 公共参数,本接口取值:2021-04-20。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
DisplayName | 是 | String | 机构节点名称,长度限制:64个字符。 |
ParentOrgNodeId | 否 | String | 父机构节点ID,如果为空则默认创建在机构根节点下。 |
Description | 否 | String | 机构节点描述。 |
CustomizedOrgNodeId | 否 | String | 机构代码。如果为空,则默认生成机构代码。如果为非空,则校验机构代码的唯一性。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
OrgNodeId | String | 机构节点ID,是机构节点的全局唯一标识。 注意:此字段可能返回 null,表示取不到有效值。 示例值:id |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求示例
输入示例
POST / HTTP/1.1
Host: eiam.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateOrgNode
<公共请求参数>
{
"DisplayName": "广州分部",
"Description": "分机构",
"CustomizedOrgNodeId": "test"
}
输出示例
{
"Response": {
"RequestId": "aed983a7-8347-****-a6ef-b04d0b6c1641",
"OrgNodeId": "b266a1d6-0cfd-****-aad1-1e5b26b0914e"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.ChildOrgNodeNameAlreadyExists | 同一组织下相同名称的子组织机构已存在。 |
FailedOperation.CreateOrgNodeError | 创建机构节点失败。 |
FailedOperation.CustomizeParentOrgNodeIdAlreadyExists | 自定义机构节点对外ID已存在。 |
FailedOperation.CustomizedOrgNodeIdCanNotBeEmpty | 自定义机构节点对外ID不可填为空字符。 |
FailedOperation.OperationError | 操作失败。 |
FailedOperation.ParentOrgNodeIdNotFound | 父机构节点ID未找到。 |
InvalidParameter.OrgCodeIllegal | 组织机构代码不合法。 |
InvalidParameterValue.ParameterIllegal | 参数不合法。 |
LimitExceeded.ParameterLengthLimitExceeded | 输入参数超出长度限制。 |