文档首页/ IoT边缘 IoTEdge/ API参考/ API列表/ 应用管理/ 创建应用
更新时间：2024-06-20 GMT+08:00
查看PDF
分享

创建应用

功能介绍

创建应用

调试

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

URI

POST /v2/{project_id}/edge-apps

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。获取方法请参见 获取项目ID。

最小长度：1

最大长度：64

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。

最小长度：0

最大长度：20000
表3 请求Body参数

参数

是否必选

参数类型

描述

edge_app_id

是

String

应用ID

最小长度：4

最大长度：32

edge_app_name

否

String

应用名称

最小长度：4

最大长度：64

description

否

String

应用描述

最小长度：0

最大长度：255

function_type

否

String

功能类型,分为数据处理（DATA_PROCESSING）、协议解析（PROTOCOL_PARSING）、IT集成（ON_PREMISE_INTEGRATION）和混合应用（COMPOSITE_APPLICATION），数据默认为DATA_PROCESSING，数据处理模块可以传输消息，协议解析为驱动类型，IT集成为部署南向3rdIA使用，混合应用可同时实现数据处理和协议解析。

最小长度：0

最大长度：255

枚举值：

  • DATA_PROCESSING

  • PROTOCOL_PARSING

  • ON_PREMISE_INTEGRATION

  • GATEWAY_MANAGER

  • COMPOSITE_APPLICATION

  • DATA_COLLECTION

protocol

否

String

驱动协议类型OPCUA|Modbus-TCP

最小长度：0

最大长度：64

响应参数

状态码： 201

表4 响应Body参数

参数

参数类型

描述

edge_app_id

String

应用id

最小长度：1

最大长度：64

description

String

应用描述

最小长度：0

最大长度：256

create_time

String

创建时间

最小长度：0

最大长度：256

update_time

String

最后一次修改时间

最小长度：0

最大长度：256

last_published_version

String

最新发布版本

最小长度：0

最大长度：64

app_type

String

应用类型SYSTEM_REQUIRED|SYSTEM_OPTIONAL|USER

最小长度：0

最大长度：64

function_type

String

应用类型DATA_PROCESSING|PROTOCOL_PARSING

最小长度：0

最大长度：64

deploy_type

String

部署类型docker|process

最小长度：0

最大长度：64

protocol

String

驱动协议类型OPCUA|Modbus-TCP

最小长度：0

最大长度：64

edge_app_name

String

应用名称

最小长度：0

最大长度：64

请求示例

POST https://{endpoint}/v2/{project_id}/edge-apps

{
  "edge_app_id" : "test-app",
  "description" : "this is a test app",
  "function_type" : "DATA_PROCESSING"
}

响应示例

状态码： 201

Created

{
  "edge_app_id" : "string",
  "description" : "string",
  "create_time" : "string",
  "update_time" : "string",
  "last_published_version" : "string",
  "app_type" : "string",
  "function_type" : "string",
  "protocol" : "string",
  "edge_app_name" : "string",
  "deploy_type" : "string"
}

状态码

状态码

描述

201

Created

401

Bad Request

500

Internal Server Error

错误码

请参见错误码。

父主题： 应用管理

相关文档