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

1. 接口描述

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

查询本地镜像组件列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeImageComponentList。
Version	是	String	公共参数，本接口取值：2020-11-01。
Region	否	String	公共参数，此参数为可选参数。
ImageID	是	String	镜像ID 示例值：sha256:b0c74d449d6f6e2883c6a39dd4ad5b9d95211778f48d30069feeaa0ffc41****
Limit	否	Integer	需要返回的数量，默认为10，最大值为100 示例值：10
Offset	否	Integer	偏移量，默认为0。示例值：0
Filters.N	否	Array of AssetFilters	过滤条件。 ComponentName- String - 是否必填：否 - 镜像组件名称 ComponentVersion- String - 是否必填：否 - 镜像组件版本 ComponentType- String - 是否必填：否 - 镜像组件类型 VulLevel- String - 是否必填：否 - 漏洞威胁等级 HasVul- String - 是否必填：否 -是否有漏洞；true：是，false，否；不传或ALL ：全部示例值：[{ "Name": "ComponentVersion", "Values": [“v1.0”], "ExactMatch": false }]
By	否	String	排序字段示例值：VulCount
Order	否	String	排序方式desc ，asc 示例值：ASC

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	总数量示例值：509
List	Array of ImageComponent	镜像组件列表示例值：[{"ImageID": "sha256:b0c74d449d6f6e2883c6a39dd4ad5b9d95211778f48d30069feeaa0ffc41", "Name": "acl", "Path": "", "Type": "SYSTEM_COMPO", "Version": "2.2.51-15****", "VulCount": 0}]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询本地镜像组件列表

输入示例

https://tcss.tencentcloudapi.com/?Action=DescribeImageComponentList
&ImageID=image-id
&Limit=10
&Offset=0
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 1,
        "List": [
            {
                "ImageID": "sha256:2ebe27d",
                "Name": "name",
                "Path": "Path",
                "Type": "SYSTEM_COMPONENT",
                "Version": "2.2.51-12.el7",
                "VulCount": 0
            }
        ],
        "RequestId": "8bc803fd-d85d-47b8-9e2b-9644674be677"
    }
}

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	内部错误。
InternalError.MainDBFail	操作数据库失败。
InvalidParameter	参数错误。
InvalidParameter.InvalidFormat	参数格式错误。
InvalidParameter.MissingParameter	缺少必须参数。
InvalidParameter.ParsingError	参数解析错误。
InvalidParameterValue	参数取值错误。
MissingParameter	缺少参数错误。
ResourceNotFound	资源不存在。