文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 资产发现/ 修改开放端口状态 - BatchModifyPortStatus
更新时间:2025-11-28 GMT+08:00
分享

修改开放端口状态 - BatchModifyPortStatus

功能介绍

修改开放端口状态

授权信息

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

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

URI

POST /v5/{project_id}/asset/batch-modify-port-status

表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

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

表4 请求Body参数

参数

是否必选

参数类型

描述

operate_type

String

参数解释:

端口状态,是否忽略

约束限制:

不涉及

取值范围:

  • ignore:忽略

  • not_ignore:取消忽略

默认取值:

不涉及

data_list

Array of PortStatusRequestInfo objects

参数解释:

主机相关信息列表

约束限制:

不涉及

取值范围:

最小值0,最大值200

默认取值:

不涉及

表5 PortStatusRequestInfo

参数

是否必选

参数类型

描述

agent_id

String

参数解释:

agent id

约束限制:

不涉及

取值范围:

字符长度0-64位

默认取值:

不涉及

port

Integer

参数解释:

本地端口号

约束限制:

不涉及

取值范围:

最小值0,最大值2147483647

默认取值:

不涉及

port_type

String

参数解释:

端口类型

约束限制:

不涉及

取值范围:

  • TCP

  • UDP

默认取值:

不涉及

container_id

String

参数解释:

容器id

约束限制:

不涉及

取值范围:

字符长度0-64位

默认取值:

不涉及

host_id

String

参数解释:

主机id

约束限制:

不涉及

取值范围:

字符长度0-64位

默认取值:

不涉及

响应参数

状态码:200

请求已成功

请求示例

修改project_id为2b31ed520xxxxxxebedb6e57xxxxxxxx,agent_id为xxx的本地端口22的危险状态为取消忽略。

POST https://{endpoint}/v5/2b31ed520xxxxxxebedb6e57xxxxxxxx/asset/batch-modify-port-status?enterprise_project_id=all_granted_eps

{
  "operate_type" : "not_ignore",
  "data_list" : [ {
    "port" : 22,
    "agent_id" : "bc36c4f848c704bb2231b1d2b72a7d8f2ae732e0d5d0aca310c7070d7c8a2886"
  } ]
}

响应示例

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档