1. 接口描述
接口请求域名: csip.tencentcloudapi.com 。
上传 Skill ZIP 文件,触发异步安全检测。上传成功后应使用返回的 ContentHash + EngineVersion 轮询 DescribeSkillScanResult 接口获取结果。上传接口具备幂等性,同一 Hash 的文件重复上传不会创建重复任务。检测结果保留90天,超期后需重新上传检测。
默认接口请求频率限制:3次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateSkillScan。 |
| Version | 是 | String | 公共参数,本接口取值:2022-11-21。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| FileBase64 | 是 | String | ZIP 文件内容的 Base64 编码 入参限制:文件大小上限 7MB(编码前),仅接受有效的 ZIP 格式 示例值:UEsDBBQAAAAIAA... |
| FileName | 否 | String | 文件名,用于服务端日志记录 参数格式:形如 my-skill.zip 示例值:my-skill.zip |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ContentHash | String | 文件的 SHA256 Hash,用于轮询 DescribeSkillScanResult 接口 参数格式:sha256:<64位hex> 示例值:sha256:a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2 |
| EngineVersion | Integer | 本次请求实际绑定的引擎版本号。调用方应保存并在后续 DescribeSkillScanResult 时显式传入 示例值:20260501 |
| Status | String | 任务状态,固定为 SCANNING,表示任务已接收 示例值:SCANNING |
| Message | String | 可读的操作结果描述 示例值:File received, scan task created |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 上传 Skill 触发检测
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateSkillScan
<公共请求参数>
{
"FileBase64": "UEsDBBQAAAAIAA...",
"FileName": "my-skill.zip"
}
输出示例
{
"Response": {
"ContentHash": "sha256:a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2",
"EngineVersion": 20260501,
"Status": "SCANNING",
"Message": "File received, scan task created",
"RequestId": "d3b7c5a1-6e4f-2d8a-9c1b-f5e3a7d2b8c6"
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。