1. 接口描述
接口请求域名： tcss.tencentcloudapi.com 。
获取镜像扫描设置信息
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeAssetImageScanSetting。 |
| Version | 是 | String | 公共参数，本接口取值：2020-11-01。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Enable | Boolean | 开关 示例值：True |
| ScanTime | String | 扫描时刻(完整时间;后端按0时区解析时分秒) 示例值：16:40 |
| ScanPeriod | Integer | 扫描间隔 示例值：7 |
| ScanVirus | Boolean | 扫描木马 示例值：True |
| ScanRisk | Boolean | 扫描敏感信息 示例值：True |
| ScanVul | Boolean | 扫描漏洞 示例值：False |
| Images | Array of String | 自定义扫描镜像 示例值：["sha256:1bcdd560259ccde678b09eff49dfe004bc100f223f7b92bd0a1ad40d0031****"] |
| ContainerRunning | Boolean | 镜像是否存在运行中的容器 示例值：False |
| ScanScope | Integer | 扫描范围 0 全部授权镜像，1自选镜像，2 推荐扫描 示例值：0 |
| ScanEndTime | String | 扫描结束时间 02:00 时分 示例值：17:00 |
| ExcludeImages | Array of String | 排除的扫描镜像 示例值：["sha256:ac6561363190fcbf423909a5b6d6dbe0c02ea8125c8857bfa455c64254db****"] |
| LastScanTime | String | 最后一次扫描时间 示例值：2024-10-30 16:4**** |
| ScanResult | String | 扫描结果(Success|InsufficientLicense|ImageNeedIsEmpty|InternalError) 示例值：Success |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取镜像扫描设置信息
输入示例
POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAssetImageScanSetting
<公共请求参数>
{}输出示例
{
"Response": {
"All": false,
"Enable": true,
"Images": [
"sha256:f8d1d3fe96d0bb9d04eab9043b53ed5280a409db58f2506e9f65caa11bb39ad1"
],
"RequestId": "6732aa52-9940-49c3-a8be-361c312b1ee5",
"ScanPeriod": 1,
"ScanRisk": false,
"ScanTime": "11:05:00",
"ScanVirus": true,
"ScanVul": false
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.MissingParameter | 缺少必须参数。 |
