1. 接口描述
接口请求域名: tcss.tencentcloudapi.com 。
镜像仓库查看定时任务
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeImageRegistryTimingScanTask。 |
Version | 是 | String | 公共参数,本接口取值:2020-11-01。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Enable | Boolean | 定时扫描开关 示例值:true |
ScanTime | String | 定时任务扫描时间 示例值:17:10 |
ScanPeriod | Integer | 定时扫描间隔 示例值:1 |
ScanType | Array of String | 扫描类型数组 示例值:[ "CVE", "VIRUS", "RISK" ] |
Images | Array of ImageInfo | 自定义扫描镜像 |
Id | Array of Integer | 自动以扫描镜像Id 示例值:128 |
Latest | Boolean | 是否扫描最新版本镜像 示例值:true |
ScanEndTime | String | 扫描结束时间 示例值:20:00 |
RegistryType | Array of String | 仓库类型 tcr,ccr,harbor 示例值:[ "azure" ] |
ContainerRunning | Boolean | 是否存在运行中的容器 示例值:false |
ScanScope | Integer | 扫描范围 0全部镜像,1自选镜像,2推荐扫描镜像 示例值:2 |
Namespace | Array of String | 命名空间 示例值:tcr-test |
ExcludeImageAssetIds | Array of Integer | 排除的镜像资产id 示例值:888 |
LastScanTime | String | 最近扫描时间 示例值:2024-10-29 17:10:00 |
ScanResult | String | 扫描结果(Success|InsufficientLicense|ImageNeedIsEmpty|InternalError) 示例值:InsufficientLicense |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 镜像仓库查看定时任务
镜像仓库查看定时任务
输入示例
POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeImageRegistryTimingScanTask
<公共请求参数>
{}
输出示例
{
"Response": {
"RequestId": "f60f0ef9-a105-4535-8dfd-42ad8b3a9c73",
"ScanTime": "03:00:00",
"ScanPeriod": 1,
"ScanType": [
"risk",
"virus"
],
"All": false,
"Images": [
{
"ImageDigest": "sha256:1319b1eaa0b7bcebae63af321fa67559b9517e8494060403d083bb3508fe52c8",
"RegistryType": "ccr",
"ImageRepoAddress": "ccr.ccs.tencentyun.com/yunding/luping:v1",
"InstanceId": "ins-apqv42***",
"InstanceName": "InstanceName",
"Namespace": "tcss",
"ImageName": "yunding/luping",
"ImageTag": "v1",
"Force": "Force"
}
],
"Id": [
1
],
"Enable": true,
"Latest": true
}
}
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 | 资源不存在。 |