1. 接口描述
接口请求域名： iss.tencentcloudapi.com 。
用于新增组织。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：AddOrganization。 |
| Version | 是 | String | 公共参数，本接口取值：2023-05-17。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| Name | 是 | String | 组织名称（仅支持中文、英文、数字、_、-的组合，长度不超过16个字符，且组织名称不能重复） 示例值：组织123 |
| ParentId | 是 | String | 组织父节点 ID（从查询组织接口DescribeOrganization中获取，填0代表根组织） 示例值：237 取值可参考： 查询组织 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | AddOrgData | 增加组织接口返回数据 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 成功1
输入示例
POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddOrganization
<公共请求参数>
{
"Name": "云api3-5",
"ParentId": "0"
}输出示例
{
"Response": {
"Data": {
"AppId": 13000000001,
"OrganizationId": "193",
"Level": 1,
"Name": "云api3-5",
"Online": 0,
"ParentId": "0",
"ParentIds": "0",
"Total": 0
},
"RequestId": "6243deef-a87a-4d5e-8c71-2ca237520df7"
}
}示例2 父组织不存在错误
输入示例
POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddOrganization
<公共请求参数>
{
"Name": "云api3-6",
"ParentId": "***"
}输出示例
{
"Response": {
"Error": {
"Code": "ResourceNotFound",
"Message": "该资源不存在"
},
"RequestId": "df1d71c3-2389-4f04-9db8-36108be0c915"
}
}示例3 组织名称重复错误
输入示例
POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddOrganization
<公共请求参数>
{
"Name": "云api3-5",
"ParentId": "***"
}输出示例
{
"Response": {
"Error": {
"Code": "InvalidParameterValue.OrgNameRepeat",
"Message": "组织名称不能重复"
},
"RequestId": "4847e307-e6ac-47b1-b6f8-bea39a66c8a9"
}
}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 | 操作失败 |
| InvalidParameter | 无效的输入参数 |
| InvalidParameterValue.InvalidOrgName | 组织名称为空或填写有误 |
| InvalidParameterValue.OrgNameRepeat | 组织名称不能重复 |
| OperationDenied.ExceededMaximumDepth | 新增组织树失败，超出组织树的最大深度 |
| ResourceNotFound | 资源不存在 |