容器安全服务查询镜像列表-镜像安全相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： tcss.tencentcloudapi.com 。

容器安全搜索查询镜像列表

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeAssetImageList。
Version	是	String	公共参数，本接口取值：2020-11-01。
Region	否	String	公共参数，此参数为可选参数。
Limit	否	Integer	需要返回的数量，默认为10，最大值为100 示例值：10
Offset	否	Integer	偏移量，默认为0。示例值：0
Filters.N	否	Array of AssetFilters	过滤条件。 ImageName- String - 是否必填：否 - 镜像名称筛选， ScanStatus - String - 是否必填：否 - 镜像扫描状态notScan，scanning，scanned，scanErr ImageID- String - 是否必填：否 - 镜像ID筛选， SecurityRisk- String - 是否必填：否 - 安全风险，VulCnt 、VirusCnt、RiskCnt、IsTrustImage 示例值：[{"Name":"ScanStatus","Values":["notScan"]}]
By	否	String	排序字段示例值：HostCnt,ContainerCnt,CreateTime,ComponentCnt,SensitiveCount
Order	否	String	排序方式 asc,desc 示例值：ASC

3. 输出参数

参数名称	类型	描述
List	Array of ImagesInfo	镜像列表示例值：[{"AgentError": "", "ComponentCnt": 999, "ContainerCnt": 0, "CreateTime": "2024-10-23T06:16", "CriticalLevelVulCnt": 0, "HighLevelVulCnt": 0, "HostCnt": 1, "ImageID": "sha256:80beff5ff34259ceb7fbe9cd10b2d94912618f5b5595f234349c5bb0cd4f", "ImageName": "registry.j..com/tcloud-yunjing-cwp-detection/tcloud-yunjing-cwp-detection:0.0.1-20241023-141138-920a71a.rhel.a***", "IsAuthorized": 0, "IsLatestImage": true, "IsSuggest": 0, "IsTrustImage": false, "LowLevelVulCnt": 0, "MediumLevelVulCnt": 0, "OsName": "", "RecommendedFix": false, "RiskCnt": 0, "ScanError": "", "ScanRiskError": "", "ScanStatus": "NOT_SCAN", "ScanTime": "", "ScanVirusError": "", "ScanVulError": "", "Size": 3840885407, "VirusCnt": 0, "VulCnt": 0}]
TotalCount	Integer	总数量示例值：1168
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询镜像列表

查询镜像列表

输入示例

POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAssetImageList
<公共请求参数>

{}

输出示例

{
    "Response": {
        "List": [
            {
                "ImageID": "sha256:2061084bfcc0d9ff44f479efc582e3ac9feaf96b556f6901bb39dbddfb9676b2",
                "ImageName": "l10:latest",
                "CreateTime": "2021-01-29T04:03:18Z",
                "Size": 16159906,
                "HostCnt": 12,
                "ContainerCnt": 0,
                "ScanTime": "2021-01-29T06:10:12.021Z",
                "VulCnt": 5,
                "ComponentCnt": 31,
                "VirusCnt": 141,
                "RiskCnt": 7,
                "IsTrustImage": true,
                "OsName": "alpine:v3.12",
                "AgentError": "No Error",
                "ScanError": "No Error",
                "ScanStatus": "SCANNED",
                "ScanVirusError": "No Error",
                "ScanVulError": "No Error",
                "ScanRiskError": "No Error",
                "IsSuggest": 0,
                "IsAuthorized": 12
            }
        ],
        "RequestId": "9c2d0eee-b4b8-4954-98ab-be69f503f77d",
        "TotalCount": 339
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameter.ParsingError	参数解析错误。
ResourceNotFound	资源不存在。