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

1. 接口描述

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

容器安全搜索查询端口占用列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeAssetPortList。
Version	是	String	公共参数，本接口取值：2020-11-01。
Region	否	String	公共参数，此参数为可选参数。
Limit	否	Integer	需要返回的数量，默认为10，最大值为100 示例值：100
Offset	否	Integer	偏移量，默认为0。示例值：0
Filters.N	否	Array of AssetFilters	过滤条件。 All - String - 是否必填：否 - 模糊查询可选字段 RunAs - String - 是否必填：否 - 运行用户筛选， ContainerID - String - 是否必填：否 - 容器id HostID- String - 是否必填：是 - 主机id HostIP- string - 是否必填：否 - 主机ip搜索 ProcessName- string - 是否必填：否 - 进程名搜索示例值：[{"ExactMatch": true, "Name": "Contain", "Values": ["6a25fff14f8be53ab2d9938434e84336b98cbb25cb840688bc809f8044f3"]}]

3. 输出参数

参数名称	类型	描述
List	Array of PortInfo	端口列表示例值：[{"ContainerName": "/k8s_coredns_coredns-6c8bcccc58-mz8gb_kube-system_b5bc2b58-12e3-4c3e-96ca-1307a6efd8", "ContainerPID": 1, "ContainerPort": 8181, "HostID": "25a117a8-70f5-4046-974f-9e3ff0b0", "HostIP": "10.31.154", "HostName": "VM-154-141-ce", "ListenContainer": "tcp://:::", "ListenHost": "", "NodeID": "", "NodeType": "NORMAL", "NodeUniqueID": "", "PodIP": "", "PodName": "", "ProcessName": "coredns", "PublicIP": "-", "PublicIp": "0.0.0.0", "PublicPort": 0, "RunAs": "root:", "Type": "tcp"}]
TotalCount	Integer	总数量示例值：7460
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询端口占用列表

查询端口占用列表

输入示例

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

{}

输出示例

{
    "Response": {
        "List": [
            {
                "ContainerName": "容器名称",
                "ContainerPID": 1,
                "ContainerPort": 8080,
                "HostID": "8bc803fd-d85d-47b8-9e2b-9644674be677",
                "HostIP": "1.1.1.1",
                "HostName": "tke_cls-111111",
                "ListenContainer": "tcp://:::8080",
                "ListenHost": "10.0.0.1",
                "NodeID": "mix-GOmf****",
                "NodeType": "NORMAL",
                "NodeUniqueID": "896e349d-2e7d-4151-a26f-4e9fdafe****",
                "PodIP": "10.0.1.92",
                "PodName": "agent-test-2zrp7",
                "ProcessName": "sh",
                "PublicIP": "10.0.1.92",
                "PublicIp": "1.1.1.1",
                "PublicPort": 0,
                "RunAs": "root:root",
                "Type": "tcp"
            }
        ],
        "TotalCount": 1,
        "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. 错误码

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

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