文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 资产管理/ 查询指定开放端口的服务器列表 - ListPortHost
更新时间:2025-10-31 GMT+08:00
分享

查询指定开放端口的服务器列表 - ListPortHost

功能介绍

查询具备该端口的主机/容器的服务器列表

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/asset/ports/detail

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

主机所属的企业项目ID。

开通企业项目功能后才需要配置企业项目。

企业项目ID默认取值为“0”,表示默认企业项目。如果需要查询所有企业项目下的主机,请传参“all_granted_eps”。如果您只有某个企业项目的权限,则需要传递该企业项目ID,查询该企业项目下的主机,否则会因权限不足而报错。

host_name

String

主机名称

host_ip

String

主机ip

port

Integer

端口号

type

String

端口类型:目前包括TCP,UDP两种

category

String

类别,默认为host,包含如下:

  • host:主机

  • container:容器

limit

Integer

每页显示数量

offset

Integer

偏移量:指定返回记录的开始位置

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

机器总数

data_list

Array of PortHostResponseInfo objects

机器信息列表

表5 PortHostResponseInfo

参数

参数类型

描述

container_id

String

镜像id

host_id

String

主机id

host_ip

String

主机ip

host_name

String

主机名称

laddr

String

监听ip

path

String

进程可执行文件路径

pid

Integer

pid

port

Integer

端口

status

String

状态

type

String

端口类型:目前包括TCP,UDP两种

container_name

String

容器名称

agent_id

String

agent id

请求示例

默认查询前10条端口为22的主机列表

GET https://{endpoint}/v5/{project_id}/asset/ports/detail?port=22

响应示例

状态码:200

请求已成功

{
  "total_num" : 1,
  "data_list" : [ {
    "host_id" : "03117200-xxxx-xxxx-xxxx-a89a10e66dbe",
    "host_ip" : "192.168.0.1",
    "host_name" : "ecs-eule",
    "laddr" : "0.0.0.0",
    "path" : "C:\\Windows\\system32\\svchost.exe",
    "port" : 888,
    "status" : "unknow",
    "type" : "UDP",
    "container_id" : "ce794b8a6-xxxx-xxxx-xxxxx-36bedf2c7a4f6083fb82e5bbc82709b50018",
    "container_name" : "hss_imagescan_W73V1WO6",
    "agent_id" : "03jjj-xxxx-xxxx-wwwsedf"
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档