tencent cloud

APIs

CreateSkillScan

下载
聚焦模式
字号
最后更新时间: 2026-06-18 18:03:24

1. API Description

Domain name for API request: csip.intl.tencentcloudapi.com.

Upload the Skill ZIP file to trigger asynchronous security detection. After a successful upload, use the returned ContentHash and EngineVersion to poll the DescribeSkillScanResult API to obtain the result. The upload API is idempotent, and uploading the same file with an identical hash will not create a repetition task. The detection result is reserved for 90 days. If overdue, reupload the file for detection.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: CreateSkillScan.
Version Yes String Common Params. The value used for this API: 2022-11-21.
Region No String Common Params. This parameter is not required.
FileBase64 Yes String Base64 encoding of the ZIP file content
Input limit: File size limit 7MB (before encoding), only effective ZIP format.
FileName No String Filename for server log
Parameter format: such as my-skill.zip

3. Output Parameters

Parameter Name Type Description
ContentHash String SHA256 Hash of the file, used for polling the DescribeSkillScanResult API
Parameter format: sha256:<64-bit hex>
EngineVersion Integer Engine version number actually bound to the current request. The caller should save and explicitly input it in the follow-up DescribeSkillScanResult.
Status String Task status, fixed as SCANNING, indicates the task is received.
Message String Readable operation result description
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Uploading Skill Trigger Detection

Input Example

POST / HTTP/1.1
Host: csip.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateSkillScan
<Common request parameters>

{
    "FileBase64": "UEsDBBQAAAAIAA...",
    "FileName": "my-skill.zip"
}

Output Example

{
    "Response": {
        "ContentHash": "sha256:a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2",
        "EngineVersion": 20260501,
        "Status": "SCANNING",
        "Message": "File received, scan task created",
        "RequestId": "d3b7c5a1-6e4f-2d8a-9c1b-f5e3a7d2b8c6"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈