1. 接口描述
接口请求域名: ctem.tencentcloudapi.com 。
查看企业列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeCustomers。 |
Version | 是 | String | 公共参数,本接口取值:2023-11-28。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Limit | 否 | Integer | 分页大小 示例值:0 |
Offset | 否 | Integer | 分页偏移 示例值:0 |
Filters.N | 否 | Array of Filter | 查询数组 |
Keyword | 否 | String | 企业名称模糊搜索 示例值:腾讯 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Total | Integer | 总数 示例值:10 |
List | Array of Customer | 企业列表 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查看企业
查看企业
输入示例
POST / HTTP/1.1
Host: ctem.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCustomers
<公共请求参数>
{}
输出示例
{
"Response": {
"List": [
{
"AppId": 1300055108,
"AuthEndAt": "",
"AuthFile": "",
"AuthStartAt": "",
"CreateAt": "2024-06-07 14:24:11",
"Creator": "",
"EnableAuth": false,
"EnableCron": false,
"EnableScanSubEnterprise": false,
"Icon": "",
"Id": 100136,
"Keywords": "",
"Name": "腾讯测试",
"Percent": 55,
"ScanCron": "",
"ScanTime": "{\"Monday\":{\"0\":false,\"1\":false,\"10\":false,\"11\":false,\"12\":false,\"13\":false,\"14\":false,\"15\":false,\"16\":false,\"17\":false,\"18\":false,\"19\":false,\"2\":false,\"20\":false,\"21\":false,\"22\":false,\"23\":false,\"3\":false,\"4\":false,\"5\":false,\"6\":false,\"7\":false,\"8\":false,\"9\":false},\"Tuesday\":{\"0\":false,\"1\":false,\"10\":false,\"11\":false,\"12\":false,\"13\":false,\"14\":false,\"15\":false,\"16\":false,\"17\":false,\"18\":false,\"19\":false,\"2\":false,\"20\":false,\"21\":false,\"22\":false,\"23\":false,\"3\":false,\"4\":false,\"5\":false,\"6\":false,\"7\":false,\"8\":false,\"9\":false},\"Wednesday\":{\"0\":false,\"1\":false,\"10\":false,\"11\":false,\"12\":false,\"13\":false,\"14\":false,\"15\":false,\"16\":false,\"17\":false,\"18\":false,\"19\":false,\"2\":false,\"20\":false,\"21\":false,\"22\":false,\"23\":false,\"3\":false,\"4\":false,\"5\":false,\"6\":false,\"7\":false,\"8\":false,\"9\":false},\"Thursday\":{\"0\":false,\"1\":false,\"10\":false,\"11\":false,\"12\":false,\"13\":false,\"14\":false,\"15\":false,\"16\":false,\"17\":false,\"18\":false,\"19\":false,\"2\":false,\"20\":false,\"21\":false,\"22\":false,\"23\":false,\"3\":false,\"4\":false,\"5\":false,\"6\":false,\"7\":false,\"8\":false,\"9\":false},\"Friday\":{\"0\":false,\"1\":false,\"10\":false,\"11\":false,\"12\":false,\"13\":false,\"14\":false,\"15\":false,\"16\":false,\"17\":false,\"18\":false,\"19\":false,\"2\":false,\"20\":false,\"21\":false,\"22\":false,\"23\":false,\"3\":false,\"4\":false,\"5\":false,\"6\":false,\"7\":false,\"8\":false,\"9\":false},\"Saturday\":{\"0\":false,\"1\":false,\"10\":false,\"11\":false,\"12\":false,\"13\":false,\"14\":false,\"15\":false,\"16\":false,\"17\":false,\"18\":false,\"19\":false,\"2\":false,\"20\":false,\"21\":false,\"22\":false,\"23\":false,\"3\":false,\"4\":false,\"5\":false,\"6\":false,\"7\":false,\"8\":false,\"9\":false},\"Sunday\":{\"0\":false,\"1\":false,\"10\":false,\"11\":false,\"12\":false,\"13\":false,\"14\":false,\"15\":false,\"16\":false,\"17\":false,\"18\":false,\"19\":false,\"2\":false,\"20\":false,\"21\":false,\"22\":false,\"23\":false,\"3\":false,\"4\":false,\"5\":false,\"6\":false,\"7\":false,\"8\":false,\"9\":false}}",
"ScanType": "资产收集",
"Uin": "600000560604",
"UpdateAt": "2024-06-07 14:24:11"
}
],
"RequestId": "cdd53649-1559-4b1d-8a54-3f0274d4e3f7",
"Total": 1
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidFilter | 无效的过滤器 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
RegionError | 地域错误 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |