1. 接口描述
接口请求域名： ess.tencentcloudapi.com 。
此API接口用来查询加入集团的成员企业信息
适用场景：子企业在加入集团后，主企业可能通过此接口获取到所有的子企业列表，方便进行展示和统计
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeOrganizationGroupOrganizations。 |
| Version | 是 | String | 公共参数，本接口取值：2020-11-11。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| Operator | 是 | UserInfo | 执行本接口操作的员工信息,userId必填。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。 |
| Limit | 是 | Integer | 指定分页每页返回的数据条数，单页最大1000 示例值：100 |
| Offset | 是 | Integer | 指定分页返回第几页的数据，如果不传默认返回第一页，页码从 0 开始，即首页为 0 示例值：0 |
| Name | 否 | String | 查询成员企业的企业名，模糊匹配 示例值：典子谦示例企业 |
| Status | 否 | Integer | 成员企业加入集团的当前状态
示例值：5 |
| Export | 否 | Boolean | 是否导出当前成员企业数据
示例值：false |
| Id | 否 | String | 成员企业机构 ID，32 位字符串，在PC控制台 集团管理可获取 示例值：yDw6yUUgyg3caowzUx4GQptRKfMnJqX8 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Total | Integer | 符合查询条件的资源实例总数量。 示例值：100 |
| JoinedTotal | Integer | 已授权待激活的子企业总数量 示例值：10 |
| ExportUrl | String | 如果入参Export为 true 时使用，表示导出Excel的url 示例值：http://file.com/exports |
| List | Array of GroupOrganization | 成员企业信息列表 |
| ActivatedTotal | Integer | 已加入的子企业总数量 示例值：50 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询集团下所有成员企业
查询集团下所有成员企业
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action:DescribeOrganizationGroupOrganizations
<公共请求参数>
{
"Operator": {
"UserId": "yDxbWUyKQDx7OZUuO4zjESvEkRMHc55R"
},
"Export": false,
"Limit": 10,
"Offset": 0
}输出示例
{
"Response": {
"ActivatedTotal": 1,
"ExportUrl": "",
"JoinedTotal": 1,
"List": [
{
"AdminInfo": {
"Mobile": "150****7992",
"Name": "王*新"
},
"Alias": "",
"FlowEngineEnable": true,
"IdCardNumber": "9***************F",
"IsMainOrganization": false,
"JoinTime": 1673166251,
"License": "",
"LicenseExpireTime": 0,
"Name": "王*新测试企业一",
"OrganizationId": "y******************C",
"Status": 2,
"UpdateTime": 1673232933
}
],
"RequestId": "s16753***7361364",
"Total": 1
}
}示例2 错误示例：Limit 超过了限制
查询子企业信息的时候，Limit 传了一个大于 1000 的数值，报错信息如下
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeOrganizationGroupOrganizations
<公共请求参数>
{
"Operator": {
"UserId": "yDxbWUyKQDx7OZUuO4zjESvEkRMHc55R"
},
"Limit": 2000,
"Offset": 0
}输出示例
{
"Response": {
"Error": {
"Code": "InvalidParameterValue",
"Message": "分页大小应该大于0小于等于1000"
},
"RequestId": "s12919239kjdksfj****klsdf"
}
}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 | 操作失败。 |
| InternalError.Api | 第三方接口失败。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.Mask | 需要屏蔽的告警。 |
| OperationDenied.Forbid | 禁止此项操作。 |
| OperationDenied.NoLogin | 用户未登录,请先登录后再操作。 |
