1. 接口描述
接口请求域名: ms.tencentcloudapi.com 。
该接口供渠道合作应用加固使用,接口调用有白名单用户限制,取消渠道合作加固中的任务
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CancelEncryptTask。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-08。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ResultId | 是 | String | 加固任务结果Id 示例值:a002b9e7-e01 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
State | Integer | 1: 取消任务成功 ; -1 :取消任务失败,原因为任务进程已结束,不能取消。 示例值:1 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 取消加固任务失败示例
加固任务不存在
输入示例
POST / HTTP/1.1
Host: ms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CancelEncryptTask
<公共请求参数>
{
"ResultId": "a002b9e7-e01"
}
输出示例
{
"Response": {
"Error": {
"Code": "ResourceNotFound.ResultIdNotFound",
"Message": "ResultId不存在。"
},
"RequestId": "9379a8bd-f165-44db-a346-a3199fab2ae3"
}
}
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.InvalidAuthorization | CAM签名/鉴权错误。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.ParameterError | 参数格式错误。 |
InvalidParameterValue | 参数取值错误。 |
ResourceNotFound.ResultIdNotFound | 加固任务id不存在。 |
UnauthorizedOperation.NotWhiteUser | 不是白名单用户。 |
UnsupportedOperation | 操作不支持。 |