文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 资产管理/ 查询某一端口的描述信息 - ShowCommonPort
更新时间:2025-10-31 GMT+08:00
分享

查询某一端口的描述信息 - ShowCommonPort

功能介绍

呈现某一端口详细信息,如本地端口:80,类型:TCP,危险程度:正常,端口描述:常用于SSH(SecureShell)-远程登录协议,用于安全登录文件传输(SCP,SFTP)及端口重新定向。

授权信息

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

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

URI

GET /v5/{project_id}/asset/common-port-info

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

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

取值范围:

字符长度1-256位

默认取值:

0,表示默认企业项目(default)。

category

String

参数解释:

资产类别

约束限制:

不涉及

取值范围:

  • host:主机资产

  • container:容器资产

默认取值:

host

port

Integer

参数解释:

端口号

约束限制:

不涉及

取值范围:

最小值1,最大值65535

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

port

Integer

参数解释

端口号

取值范围

最小值1,最大值65535

type

String

参数解释

端口类型

取值范围

  • TCP:TCP协议

  • UDP:UDP协议

  • TCP6:TCP6协议

  • UDP6:UDP6协议

status

String

参数解释

状态

取值范围

  • normal:正常

  • danger:危险

  • unknow:未知

description

String

参数解释

中文描述

取值范围

字符长度1-256

description_en

String

参数解释

英文描述

取值范围

字符长度1-256

请求示例

响应示例

状态码:200

请求已成功

{
  "port" : 666,
  "type" : "TCP",
  "status" : "normal",
  "description" : "木马AttackFTP、SatanzBackdoor",
  "description_en" : "Trojan horses Attack FTP and Satanz Backdoor"
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档