1. 接口描述
接口请求域名: ctem.tencentcloudapi.com 。
创建企业
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateCustomer。 |
Version | 是 | String | 公共参数,本接口取值:2023-11-28。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Name | 是 | String | 企业名称 示例值:腾讯科技 |
ScanType | 是 | String | 资产收集、漏洞信息、弱口令、目录爆破、暗网泄露、Github泄露、文库网盘泄露、敏感信息泄露,其中资产收集必包含,多个用英文逗号隔离,例如:资产收集,漏洞信息 示例值:资产收集,漏洞信息 |
Percent | 否 | Integer | 百分比取值范围为30-100 示例值:50 |
ScanCron | 否 | String | 周期测绘时间 示例值:每日#0 0 * * * * |
IsScanNow | 否 | Boolean | 是否立即启动 示例值:false |
EnableCron | 否 | Boolean | 是否启用周期测绘 示例值:false |
EnableScanSubEnterprise | 否 | Boolean | 是否扫描子公司 示例值:false |
EnableAuth | 否 | Boolean | 是否授权 示例值:false |
AuthStartAt | 否 | String | 授权开始时间 示例值:2024-01-01 00:00:00 |
AuthEndAt | 否 | String | 授权结束时间 示例值:2025-01-01 00:00:00 |
AuthFile | 否 | String | 授权文件id |
ScanTime | 否 | String | 测绘时间配置项,采用json字符串格式 示例值:{"Monday":{"0":true},"Tuesday":{"1":true},"Wednesday":{"2":true},"Thursday":{"3":true},"Friday":{"4":true},"Saturday":{"5":true},"Sunday":{"23":true}} |
Keywords | 否 | String | 企业相关的关键字 |
Icon | 否 | String | 图标 |
Qps | 否 | Integer | 并发设置 |
SubCompanyLevel | 否 | Integer | 限制子公司层级,-1表示不限制 示例值:-1 |
IsIncludeFullScan | 否 | Boolean | 是否以企业名称为起点做完整扫描(包含手动上传),如只想扫描特定的某几个域名,则传false。 示例值:false |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例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: 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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidFilter | 无效的过滤器 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
RegionError | 地域错误 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |