1. 接口描述
接口请求域名: tcss.tencentcloudapi.com 。
镜像仓库更新定时任务
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:UpdateImageRegistryTimingScanTask。 |
Version | 是 | String | 公共参数,本接口取值:2020-11-01。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
ScanPeriod | 是 | Integer | 定时扫描周期 |
Enable | 是 | Boolean | 定时扫描开关 |
ScanTime | 是 | String | 定时扫描的时间 |
ScanType.N | 否 | Array of String | 扫描木马类型数组 |
Images.N | 否 | Array of ImageInfo | 扫描镜像 |
Id.N | 否 | Array of Integer | 扫描镜像Id |
Latest | 否 | Boolean | 是否扫描最新版本 |
ContainerRunning | 否 | Boolean | 是否存在运行中的容器 |
ScanEndTime | 否 | String | 扫描结束时间 |
ScanScope | 否 | Integer | 扫描范围 0全部镜像,1自选镜像,2推荐扫描镜像 |
RegistryType.N | 否 | Array of String | 仓库类型 tcr,ccr,harbor |
Namespace.N | 否 | Array of String | 命名空间 |
ExcludeImageAssetIds.N | 否 | Array of Integer | 排除的镜像资产id |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 定时扫描-扫描全部已授权的最新版本镜像
扫描全部已授权的最新版本镜像,扫描类型:漏洞
输入示例
POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateImageRegistryTimingScanTask
<公共请求参数>
{
"ScanPeriod": 1,
"ScanType": [
"CVE"
],
"Images": [
{
"ImageDigest": "abc",
"RegistryType": "abc",
"ImageRepoAddress": "abc",
"InstanceId": "abc",
"InstanceName": "abc",
"Namespace": "abc",
"ImageName": "abc",
"ImageTag": "abc",
"Force": "abc"
}
],
"All": true,
"Latest": true,
"Enable": true,
"ScanTime": "04:00:00",
"Id": [
1
]
}
输出示例
{
"Response": {
"RequestId": "abc"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidParameter | 参数错误。 |
ResourceNotFound | 资源不存在。 |