1. 接口描述
接口请求域名： tcss.tencentcloudapi.com 。
镜像仓库查询一键镜像扫描状态
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeAssetImageRegistryScanStatusOneKey。 |
| Version | 是 | String | 公共参数，本接口取值：2020-11-01。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| Images.N | 否 | Array of ImageInfo | 需要获取进度的镜像列表 示例值：[{"Namespace":"name","InstanceName":"ins-hdjh***","ImageName":"imageName-01","ImageTag":"tag","Force":true}] |
| All | 否 | Boolean | 是否获取全部镜像 示例值：True |
| Id.N | 否 | Array of Integer | 需要获取进度的镜像列表Id 示例值：[2535] |
| TaskID | 否 | Integer | 获取进度的任务ID 示例值：100 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ImageTotal | Integer | 镜像个数 示例值：1647 |
| ImageScanCnt | Integer | 扫描镜像个数 示例值：1484 |
| ImageStatus | Array of ImageProgress | 扫描进度列表 示例值：[{"ImageId":"sha256:08b152afcfae220e9709f00767054b824361c742ea03a9fe936271ba520a0a4b"}] |
| SuccessCount | Integer | 安全个数 示例值：1484 |
| RiskCount | Integer | 风险个数 示例值：161 |
| Schedule | Integer | 总的扫描进度 示例值：100 |
| Status | String | 总的扫描状态 示例值：CANCELED |
| ScanRemainTime | Integer | 扫描剩余时间 示例值：0 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 正常请求
正常请求
输入示例
POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAssetImageRegistryScanStatusOneKey
<公共请求参数>
{
"TaskID": 13
}输出示例
{
"Response": {
"ImageScanCnt": 0,
"ImageStatus": [],
"ImageTotal": 1525,
"RequestId": "a8298892-31c6-4a39-84e2-ce998b5822fd",
"RiskCount": 0,
"ScanRemainTime": 0,
"Schedule": 0,
"Status": "SCANNING",
"SuccessCount": 0
}
}示例2 镜像仓库查询一键镜像扫描状态
镜像仓库查询一键镜像扫描状态
输入示例
POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAssetImageRegistryScanStatusOneKey
<公共请求参数>
{
"All": true,
"TaskID": 2257
}输出示例
{
"Response": {
"ImageScanCnt": 0,
"ImageStatus": [],
"ImageTotal": 1,
"RequestId": "2d6532f3-28b8-4a99-863b-e178b3c5c416",
"RiskCount": 1,
"ScanRemainTime": 0,
"Schedule": 100,
"Status": "SCAN_TIMEOUT",
"SuccessCount": 0
}
}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 | 内部错误。 |
| MissingParameter | 缺少参数错误。 |
| ResourceNotFound | 资源不存在。 |
