1. 接口描述
接口请求域名： cfw.tencentcloudapi.com 。
资产扫描
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyAssetScan。 |
| Version | 是 | String | 公共参数，本接口取值：2019-09-04。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| ScanRange | 是 | Integer | 扫描范围：1端口, 2端口+漏扫 示例值：1 |
| ScanDeep | 是 | String | 扫描深度：'heavy', 'medium', 'light' 示例值：heavy |
| RangeType | 是 | Integer | 扫描类型：1立即扫描 2 周期任务 示例值：1 |
| ScanPeriod | 否 | String | RangeType为2 是必须添加，定时任务时间 示例值：每周-星期四/12:51:00 |
| ScanFilterIp.N | 否 | Array of String | 立即扫描这个字段传过滤的扫描集合 示例值：["9.10.10.1","9.10.10.2"] |
| ScanType | 否 | Integer | 1全量2单个 示例值：1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ReturnMsg | String | 接口返回信息 示例值：success |
| ReturnCode | Integer | 接口返回错误码，0请求成功 非0失败 示例值：0 |
| Status | Integer | 状态值 0：成功，1 执行扫描中,其他：失败 示例值：1 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 资产扫描
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAssetScan
<公共请求参数>
{
"ScanRange": 1,
"ScanDeep": "heavy",
"RangeType": 2,
"ScanPeriod": "每周-星期四/12:51:00",
"ScanFilterIp": [
"11",
"22"
]
}输出示例
{
"Response": {
"Status": 0,
"ReturnCode": 0,
"ReturnMsg": "success",
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InvalidParameter | 参数错误。 |
| LimitExceeded | 超过配额限制。 |
