更新时间:2025-11-28 GMT+08:00
分享

启动插件 - StartPlugin

功能介绍

启动插件

授权信息

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

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

URI

POST /v5/{project_id}/plugins/attachments/start

表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)。

请求参数

表3 请求Body参数

参数

是否必选

参数类型

描述

plugin_code

String

参数解释

插件编码

约束限制:

不涉及

取值范围:

字符长度1-64位

默认取值:

不涉及

operate_all

Boolean

参数解释

是否是全量操作,优先级高于host_id_list,若取值为true且host_id_list不为空,仍执行全量操作

约束限制:

不涉及

取值范围:

  • true:全量操作,启动/停止所有符合条件的插件

  • false: 非全量操作,仅对host_id_list内服务器执行启动/停止插件操作

默认取值:

false

host_id_list

Array of strings

参数解释

服务器ID列表

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

请求已成功

请求示例

启动服务器71a15ecc-049f-4cca-bd28-xxx上的ndr插件

{
  "plugin_code" : "ndr",
  "operate_all" : false,
  "host_id_list" : [ "71a15ecc-049f-4cca-bd28-xxx" ]
}

响应示例

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档