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

1. 接口描述

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

容器安全搜索查询主机列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeAssetHostList。
Version	是	String	公共参数，本接口取值：2020-11-01。
Region	否	String	公共参数，此参数为可选参数。
Limit	否	Integer	需要返回的数量，默认为10，最大值为100 示例值：10
Offset	否	Integer	偏移量，默认为0。示例值：0
Filters.N	否	Array of AssetFilters	过滤条件。 Status-String-是否必填：否-agent状态筛选，"ALL": "全部"(或不传该字段), "UNINSTALL"："未安装", "OFFLINE"："离线", "ONLINE"："防护中" HostName-String-是否必填：否-主机名筛选 Group-String-是否必填：否-主机群组搜索 HostIP-string-是否必填：否-主机ip搜索 HostID-string-是否必填：否-主机id搜索 DockerVersion-string-是否必填：否-docker版本搜索 MachineType-string-是否必填：否-主机来源MachineType搜索，"ALL": "全部"(或不传该字段), 主机来源：[ "CVM", "ECM", "LH", "BM" ]中的之一为腾讯云服务器；[ "Other" ]之一非腾讯云服务器； DockerStatus-string-是否必填：否-docker安装状态，"ALL": "全部"(或不传该字段), "INSTALL": "已安装", "UNINSTALL": "未安装" ProjectID-string-是否必填：否-所属项目id搜索 Tag:(tag: key)-string-是否必填：否-标签键值搜索示例Filters":[{"Name":"tag: tke-kind","Values":["service"]}] NonClusterNode: 是否查询非集群节点(true: 是,false: 否) 示例值：[{"ExactMatch":true,"Name":"Status","Values":["ONLINE","OFFLINE"]}]
By	否	String	排序字段示例值：DockerVersion
Order	否	String	排序方式 asc,desc 示例值：asc

3. 输出参数

参数名称	类型	描述
List	Array of HostInfo	主机列表示例值：[ { "HostID": "223e6323-1db6-42cf-8094-200916841684", "HostIP": "10.0.0.11", "HostName": "ins-1684ad", "Group": "staffs", "DockerVersion": "1.0.0", "DockerFileSystemDriver": "ZFS", "ImageCnt": 1, "ContainerCnt": 1, "Status": "ONLINE", "IsContainerd": true, "MachineType": "CVM", "PublicIp": "112.46.12.11", "Uuid": "223e6323-1db6-42cf-8094-200916841684", "InstanceID": "ins-1684ad", "RegionID": 1, "Project": { "ProjectName": "ap-beijing", "ProjectID": 0 }, "Tags": [ { "TagKey": "adone", "TagValue": "mark" } ], "ClusterID": "csbd-cawfdfafd", "ClusterName": "cls-test1", "ClusterAccessedStatus": "1", "ChargeCoresCnt": 1, "DefendStatus": "running", "CoresCnt": 1 } ]
TotalCount	Integer	总数量示例值：1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询主机列表

查询主机列表

输入示例

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

{}

输出示例

{
    "Response": {
        "List": [
            {
                "HostID": "223e6323-1db6-42cf-8094-200916841684",
                "HostIP": "10.0.0.11",
                "HostName": "ins-1684ad1f2",
                "Group": "staffs",
                "DockerVersion": "1.0.0",
                "DockerFileSystemDriver": "ZFS",
                "ImageCnt": 1,
                "ContainerCnt": 1,
                "Status": "ONLINE",
                "IsContainerd": true,
                "MachineType": "CVM",
                "PublicIp": "112.46.12.11",
                "Uuid": "223e6323-1db6-42cf-8094-200916841684",
                "InstanceID": "ins-1684ad1f2",
                "RegionID": 1,
                "Project": {
                    "ProjectName": "ap-beijing",
                    "ProjectID": 0
                },
                "Tags": [
                    {
                        "TagKey": "adone",
                        "TagValue": "mark"
                    }
                ],
                "ClusterID": "csbd-cawfdfafd",
                "ClusterName": "cls-test1",
                "ClusterAccessedStatus": "1",
                "ChargeCoresCnt": 1,
                "DefendStatus": "running",
                "CoresCnt": 1
            }
        ],
        "TotalCount": 1,
        "RequestId": "dc56fda9-58c8-4c4f-9e8c-b7296836c1fe"
    }
}

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	资源不存在。