查询单服务器的开放端口列表 - ListPorts
功能介绍
查询单服务器的开放端口列表
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/asset/ports
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
host_id |
是 |
String |
参数解释: 服务器ID 约束限制: 不涉及 取值范围: 字符长度0-128位 默认取值: 不涉及 |
|
host_name |
否 |
String |
参数解释: 服务器名称 约束限制: 不涉及 取值范围: 字符长度0-128位 默认取值: 不涉及 |
|
host_ip |
否 |
String |
参数解释: 主机IP 约束限制: 不涉及 取值范围: 字符长度0-128位 默认取值: 不涉及 |
|
port |
否 |
Integer |
参数解释: 端口号 约束限制: 不涉及 取值范围: 最小值1，最大值65535 默认取值: 不涉及 |
|
type |
否 |
String |
参数解释: 端口类型：目前包括TCP，UDP两种 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
status |
否 |
String |
参数解释: 端口状态 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
enterprise_project_id |
否 |
String |
参数解释: 主机所属的企业项目ID。 企业项目ID默认取值为“0”，表示默认企业项目。如果需要查询所有企业项目下的主机，请传参“all_granted_eps”。如果您只有某个企业项目的权限，则需要传递该企业项目ID，查询该企业项目下的主机，否则会因权限不足而报错。 约束限制: 开通企业项目功能后才需要配置企业项目。 取值范围: 字符长度0-256位 默认取值: 0 |
|
limit |
否 |
Integer |
参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 取值10-200 默认取值: 10 |
|
offset |
否 |
Integer |
参数解释: 偏移量：指定返回记录的开始位置 约束限制: 不涉及 取值范围: 最小值0，最大值2000000 默认取值: 默认为0 |
|
category |
否 |
String |
参数解释: 类别，默认为host 约束限制: 不涉及 取值范围:
默认取值: host |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Integer |
参数解释: 开放端口总数 取值范围: 最小值0，最大值10000 |
|
data_list |
Array of PortResponseInfo objects |
参数解释： 端口信息列表 取值范围： 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
host_id |
String |
参数解释: 主机ID 取值范围: 字符长度1-128位 |
|
laddr |
String |
参数解释: 监听ip 取值范围: 字符长度1-128位 |
|
status |
String |
参数解释: 端口状态 取值范围:
|
|
port |
Integer |
参数解释: 端口号 取值范围: 最小值0，最大值65535 |
|
type |
String |
参数解释: 端口类型：目前包括TCP，UDP两种 取值范围:
|
|
pid |
Integer |
参数解释: 进程ID 取值范围: 最小值1，最大值65535 |
|
path |
String |
参数解释: 进程可执行文件路径 取值范围: 字符长度1-256位 |
|
agent_id |
String |
参数解释: Agent ID 取值范围: 字符长度1-64位 |
|
container_id |
String |
参数解释: 容器ID 取值范围: 字符长度0-128位 |
请求示例
默认查询前10条host_id为dd91cd32-a238-4c0e-bc01-3b11653714ac的开放端口列表
GET https://{endpoint}/v5/{project_id}/asset/ports?hlimit=10&offset=0&host_id=dd91cd32-a238-4c0e-bc01-3b11653714ac
响应示例
状态码：200
请求已成功
{
"data_list" : [ {
"agent_id" : "eb5d03f02fffd85aaf5d0ba5c992d97713244f420e0b076dcf6ae0574c78aa4b",
"container_id" : "",
"host_id" : "dd91cd32-a238-4c0e-bc01-3b11653714ac",
"laddr" : "0.0.0.0",
"path" : "/usr/sbin/dhclient",
"pid" : 1507,
"port" : 68,
"status" : "unknow",
"type" : "UDP"
}, {
"agent_id" : "eb5d03f02fffd85aaf5d0ba5c992d97713244f420e0b076dcf6ae0574c78aa4b",
"container_id" : "",
"host_id" : "dd91cd32-a238-4c0e-bc01-3b11653714ac",
"laddr" : "127.0.0.1",
"path" : "/usr/sbin/chronyd",
"pid" : 493,
"port" : 323,
"status" : "unknow",
"type" : "UDP"
} ],
"total_num" : 2
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。
