创建应用
功能介绍
创建应用
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v2/{project_id}/edge-apps
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。获取方法请参见 获取项目ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
edge_app_id |
是 |
String |
应用ID |
|
edge_app_name |
否 |
String |
应用名称 |
|
description |
否 |
String |
应用描述 |
|
function_type |
否 |
String |
功能类型,分为数据处理(DATA_PROCESSING)、协议解析(PROTOCOL_PARSING)、IT集成(ON_PREMISE_INTEGRATION)和混合应用(COMPOSITE_APPLICATION),数据默认为DATA_PROCESSING,数据处理模块可以传输消息,协议解析为驱动类型,IT集成为部署南向3rdIA使用,混合应用可同时实现数据处理和协议解析。 |
|
protocol |
否 |
String |
驱动协议类型OPCUA|Modbus-TCP |
|
delivered_app |
否 |
Boolean |
是否是下发到端侧网关上应用。 |
响应参数
状态码:201
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
edge_app_id |
String |
应用id |
|
description |
String |
应用描述 |
|
create_time |
String |
创建时间 |
|
update_time |
String |
最后一次修改时间 |
|
last_published_version |
String |
最新发布版本 |
|
app_type |
String |
应用类型SYSTEM_REQUIRED|SYSTEM_OPTIONAL|USER |
|
function_type |
String |
应用类型DATA_PROCESSING|PROTOCOL_PARSING |
|
deploy_type |
String |
部署类型docker|process |
|
protocol |
String |
驱动协议类型OPCUA|Modbus-TCP |
|
edge_app_name |
String |
应用名称 |
|
delivered_app |
Boolean |
是否是下发到端侧网关上应用。 |
请求示例
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 |
错误码
请参见错误码。