1. 接口描述
接口请求域名: csip.tencentcloudapi.com 。
CSIP 手动扫描任务删除接口
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ScanCSIPTaskAgain。 |
| Version | 是 | String | 公共参数,本接口取值:2022-11-21。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| TaskId | 是 | Integer | 扫描任务ID 示例值:3086642 |
| MemberId.N | 否 | Array of String | 集团账号的成员id 示例值:["mem-tencent-e74488e0ba0cd8fe"] |
| InstanceIDList.N | 否 | Array of String | 限定本次重扫的目标主机列表;为空时取主表对应子表的全量 实例ID;长度上限 1000 示例值:["ins-f9324z7u"] |
| TimeoutPeriod | 否 | Integer | 扫描超时时长(秒),可选。非零时更新一键扫描超时配置并同步更新子表 timeout 字段。上限 7200 秒(2小时),超出返回 InvalidParameter。 示例值:3600 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| SuccessCount | Integer | 本次实际触发重扫的机器数(= 状态白名单过滤后的候选机器数)单位:个 示例值:1 |
| TaskId | Integer | 原任务 ID(与入参一致;CWP 原版同样返回原 ID 而非新 ID,重扫为原地复用) 示例值:3086642 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 重新扫描
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ScanCSIPTaskAgain
<公共请求参数>
{
"TaskId": 3086642,
"MemberId": [
"mem-tencent-e74488e0ba0cd8fe"
],
"InstanceIDList": [
"ins-f9324z7u"
],
"TimeoutPeriod": 3600
}
输出示例
{
"Response": {
"SuccessCount": 1,
"TaskId": 3086642,
"RequestId": "4c2cb4c4-0131-4540-98b8-771af40a4517"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |