1. 接口描述
接口请求域名: ssl.tencentcloudapi.com 。
查询管理人列表
默认接口请求频率限制:10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeManagers。 |
Version | 是 | String | 公共参数,本接口取值:2019-12-05。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
CompanyId | 是 | Integer | 公司ID,可以从DescribeCompanies接口获取 示例值:12 |
Offset | 否 | Integer | 分页偏移量,如果不传默认值为0 示例值:0 |
Limit | 否 | Integer | 分页每页数量,如果不传默认值为10,最大值为1000 示例值:10 |
ManagerName | 否 | String | 管理人姓名(将废弃),请使用SearchKey 示例值:腾讯 |
ManagerMail | 否 | String | 模糊查询管理人邮箱(将废弃),请使用SearchKey 示例值:tencent@tencent.com |
Status | 否 | String | 根据管理人状态进行筛选,取值有 'none' 未提交审核 'audit', 亚信审核中 'CAaudit' CA审核中 'ok' 已审核 'invalid' 审核失败 'expiring' 即将过期 'expired' 已过期 示例值:audit |
SearchKey | 否 | String | 根据这样的格式:管理人姓|管理人名|邮箱|部门 ,进行精准匹配 示例值:luke|sky|tencent@tencent.com|开发一部 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Managers | Array of ManagerInfo | 公司管理人列表 |
TotalCount | Integer | 公司管理人总数 示例值:10 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询管理人列表
输入示例
POST / HTTP/1.1
Host: ssl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeManagers
<公共请求参数>
{
"CompanyId": 89002,
"Offset": 0,
"Limit": 10,
"ManagerName": "luke",
"ManagerMail": "luke@qq.com",
"Status": "ok",
"SearchKey": "luke"
}
输出示例
{
"Response": {
"Managers": [
{
"Status": "ok",
"ManagerFirstName": "luke",
"ManagerLastName": "zhang",
"ManagerPosition": "SRE",
"ManagerPhone": "18*******99",
"ManagerMail": "luke@qq.com",
"ManagerDepartment": "IT",
"CreateTime": "2021-09-11 12:00:00",
"DomainCount": 0,
"CertCount": 0,
"ManagerId": 0,
"ExpireTime": "2022-09-11 12:00:00",
"SubmitAuditTime": "2022-08-11 12:00:00",
"VerifyTime": "2022-09-01 12:00:00",
"StatusInfo": [
{
"Type": "ov",
"Status": "active",
"CreateTime": "2021-09-11 12:00:00",
"ExpireTime": "2022-09-11 12:00:00"
}
]
}
],
"TotalCount": 0,
"RequestId": "14727a68-3b90-4408-99c9-dea6d7de9456"
}
}
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.InvalidParam | 参数有误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |