容器安全服务查询漏洞影响的镜像列表

1. 接口描述

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

查询漏洞影响的镜像列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeVulImageList。
Version	是	String	公共参数，本接口取值：2020-11-01。
Region	否	String	公共参数，此参数为可选参数。
PocID	是	String	漏洞PocID 示例值：1
Limit	否	Integer	需要返回的数量，默认为10，最大值为100 示例值：10
Offset	否	Integer	偏移量，默认为0。示例值：0
Filters.N	否	Array of RunTimeFilters	过滤条件。 OnlyAffectedNewestImage- Bool- 是否必填：否 - 仅展示影响最新版本镜像的漏洞 ImageID- string - 是否必填：否 - 镜像ID ImageName- String -是否必填: 否 - 镜像名称 HostIP- string -是否必填: 否 - 内网IP PublicIP- string -是否必填: 否 - 外网IP ComponentName- string -是否必填: 否 - 组件名称 ComponentVersion- string -是否必填: 否 - 组件版本 HostName- string -是否必填: 否 - 主机名称示例值：{ "Name": "ImageName", "Values": [“name”], "ExactMatch": false }
Order	否	String	排序方式示例值：ASC
By	否	String	排序字段示例值：HostCnt

3. 输出参数

参数名称	类型	描述
List	Array of VulAffectedImageInfo	受影响的镜像列表示例值：[{"ComponentList": [{"FixedVersion": "0:1.33.0-5.e", "Name": "libngh", "Path": "", "Version": "1.33.0-3.el8"}], "ContainerCount": 0, "HostCount": 1, "ImageID": "sha256:5d0da3dc976460b72c77d94c8a1ad043720b0416bfc16c52c45d4847e53f", "ImageName": "centos:la****"}]
TotalCount	Integer	镜像总数示例值：1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询漏洞影响的镜像列表

输入示例

https://tcss.tencentcloudapi.com/?Action=DescribeVulImageList
&PocID=1
&<公共请求参数>

输出示例

{
    "Response": {
        "List": [
            {
                "ComponentList": [
                    {
                        "FixedVersion": ">6.0.37,>8.0.0",
                        "Name": "catalina",
                        "Path": "tomcat7/apache-tomcat-7.0.34/lib/catalina.jar",
                        "Version": "7.0.34"
                    }
                ],
                "ContainerCount": 0,
                "HostCount": 1,
                "ImageID": "sha256:5e1476716a780a0bf6d4776d02840254257a6c0711fe0e17a7d693aba0dff8fb",
                "ImageName": "image"
            }
        ],
        "RequestId": "940b7fab-b4fc-4740-a719-6c1dd122af3f",
        "TotalCount": 1
    }
}

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. 错误码

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameter.InvalidFormat	参数格式错误。
InvalidParameter.MissingParameter	缺少必须参数。
InvalidParameter.ParsingError	参数解析错误。
MissingParameter	缺少参数错误。
ResourceNotFound	资源不存在。