文档首页/ 智能边缘平台 IEF/ API参考/ API/ 插件管理/ 安装插件实例 - CreatePluginInstance
更新时间：2026-05-30 GMT+08:00
查看PDF
分享

安装插件实例 - CreatePluginInstance

功能介绍

安装插件实例

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

POST /v3/{project_id}/edgemgr/plugins

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

ief-Instance-Id

否

String

企业版实例ID，专业版实例为空值
表3 请求Body参数

参数

是否必选

参数类型

描述

metadata

否

PluginInstanceMetadata object

插件基本信息

spec

是

PluginInstanceSpec object

插件实例属性
表4 PluginInstanceMetadata

参数

是否必选

参数类型

描述

name

是

String

插件实例名称

uid

否

String

插件实例uid

description

否

String

插件实例描述

labels

否

Map<String,String>

插件实例属性

tags

否

Array of Attributes objects

插件实例标签
表5 Attributes

参数

是否必选

参数类型

描述

key

否

String

节点属性的key值，长度取值范围为1~128， 仅允许大小写英文字母、数字、下划线、中划线

value

否

String

节点属性的value值，长度取值范围为1~256， 仅允许大小写英文字母、数字、下划线、中划线
表6 PluginInstanceSpec

参数

是否必选

参数类型

描述

type

是

String

插件类型

version

是

String

插件版本号

node_ids

否

Array of strings

插件实例部署到指定的节点ID列表

configs

否

Map<String,String>

插件配置

resources

否

Resources object

插件实例使用的资源
表7 Resources

参数

是否必选

参数类型

描述

limits

否

LimitsRequests object

允许容器使用的最大资源

requests

否

LimitsRequests object

容器需要使用的最小资源
表8 LimitsRequests

参数

是否必选

参数类型

描述

cpu

否

String

cpu核数，大于等于0.01，最大1000；请求不需要带单位

memory

否

String

内存大小，单位兆，大于等于0.01，最大1024000。注意：内存的limits值最小为4；请求不需要带单位

gpu

否

String

Gpu显存大小，单位兆，大于等于0.01，最大1024000；请求不需要带单位

npu

否

String

Npu个数，大于0，最大1000；请求不需要带单位

响应参数

状态码：201

表9 响应Body参数

参数

参数类型

描述

plugin_instance

PluginInstance object

插件实例

node_condition

NodeCondition object

插件实例的节点绑定情况
表10 PluginInstance

参数

参数类型

描述

metadata

PluginInstanceMetadata object

插件基本信息

spec

PluginInstanceSpec object

插件实例属性

status

PluginInstanceStatus object

插件实例状态
表11 PluginInstanceMetadata

参数

参数类型

描述

name

String

插件实例名称

uid

String

插件实例uid

description

String

插件实例描述

labels

Map<String,String>

插件实例属性

tags

Array of Attributes objects

插件实例标签
表12 Attributes

参数

参数类型

描述

key

String

节点属性的key值，长度取值范围为1~128， 仅允许大小写英文字母、数字、下划线、中划线

value

String

节点属性的value值，长度取值范围为1~256， 仅允许大小写英文字母、数字、下划线、中划线
表13 PluginInstanceSpec

参数

参数类型

描述

type

String

插件类型

version

String

插件版本号

node_ids

Array of strings

插件实例部署到指定的节点ID列表

configs

Map<String,String>

插件配置

resources

Resources object

插件实例使用的资源
表14 Resources

参数

参数类型

描述

limits

LimitsRequests object

允许容器使用的最大资源

requests

LimitsRequests object

容器需要使用的最小资源
表15 LimitsRequests

参数

参数类型

描述

cpu

String

cpu核数，大于等于0.01，最大1000；请求不需要带单位

memory

String

内存大小，单位兆，大于等于0.01，最大1024000。注意：内存的limits值最小为4；请求不需要带单位

gpu

String

Gpu显存大小，单位兆，大于等于0.01，最大1024000；请求不需要带单位

npu

String

Npu个数，大于0，最大1000；请求不需要带单位
表16 PluginInstanceStatus

参数

参数类型

描述

createdAt

String

插件实例创建时间

phase

String

插件实例运行状态，包含：

  • 运行中：Running

  • 处理中：Processing

  • 未就绪：NotReady

  • 删除中：Deleting

currentNumberScheduled

Integer

当前运行插件实例容器的节点数

desiredNumberScheduled

Integer

需要运行插件实例容器且调度成功的节点数

updatedNumberScheduled

Integer

正在运行更新后的插件实例容器的节点总数

numberReady

Integer

应该运行插件实例容器，并且实例容器已就绪的节点数

numberMisscheduled

Integer

正在运行插件实例容器，但不该运行的节点数

numberAvailable

Integer

应该运行插件实例容器，并且实例容器正在运行和可用的节点数
表17 NodeCondition

参数

参数类型

描述

success_nodes_add

Array of strings

绑定插件实例成功的节点

failed_nodes_add

Array of strings

绑定插件实例失败的节点

success_nodes_del

Array of strings

解绑插件实例成功的节点

failed_nodes_del

Array of strings

解绑插件实例失败的节点

请求示例

无

响应示例

无

状态码

状态码

描述

201

安装插件实例返回体

错误码

请参见错误码。

父主题： 插件管理

相关文档