发布应用
功能介绍
批量发布应用,不允许发布同名的应用。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v1/{project_id}/app-groups/{app_group_id}/apps
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 |
|
app_group_id |
是 |
String |
应用组ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
items |
是 |
Array of PublishApp objects |
发布应用列表(单次最多20个应用)。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
是 |
String |
应用名称,名称需满足如下规则:
|
|
version |
否 |
String |
应用版本号。 |
|
command_param |
否 |
String |
启动命令行参数。 |
|
icon_uri |
否 |
String |
图标地址,该字段当前未使用。
说明:
|
|
execute_path |
是 |
String |
执行路径。 |
|
work_path |
否 |
String |
应用工作目录。 |
|
icon_path |
否 |
String |
应用图标的路径。 |
|
icon_index |
否 |
Integer |
应用图标的索引。 |
|
description |
否 |
String |
应用描述。 |
|
source_type |
是 |
Integer |
应用类型:
|
|
publisher |
否 |
String |
应用发布者。 |
|
source_image_ids |
否 |
Array of strings |
镜像ids,最多20个。 |
|
sandbox_enable |
否 |
Boolean |
是否使用沙箱模式运行,取值为:
|
|
app_extended_info |
否 |
AppExtendedInfo object |
自定义应用业务扩展信息。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
count |
Integer |
总数。 |
|
items |
Array of App objects |
查发布的应用列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
应用ID。 |
|
name |
String |
应用名称。 |
|
version |
String |
应用版本号。 |
|
command_param |
String |
启动命令行参数。 |
|
execute_path |
String |
执行路径。 |
|
work_path |
String |
应用工作目录。 |
|
icon_path |
String |
应用图标的路径。 |
|
icon_index |
Integer |
应用图标的索引。 |
|
description |
String |
应用描述。 |
|
app_group_id |
String |
应用组标识Id。 |
|
state |
String |
应用状态:
|
|
tenant_id |
String |
所在的租户ID。 |
|
publish_at |
String |
发布时间。 |
|
source_type |
Integer |
应用类型:
|
|
publisher |
String |
应用发布者。 |
|
icon_url |
String |
图标url。 |
|
publishable |
Boolean |
是否可发布应用:
|
|
sandbox_enable |
Boolean |
是否使用沙箱模式运行,取值为:
|
|
is_pre_boot |
Boolean |
是否开启应用预开,取值为:
|
|
app_extended_info |
AppExtendedInfo object |
自定义应用业务扩展信息。 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码,失败时返回。 |
|
error_msg |
String |
错误描述。 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码,失败时返回。 |
|
error_msg |
String |
错误描述。 |
状态码:403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码,失败时返回。 |
|
error_msg |
String |
错误描述。 |
状态码:404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码,失败时返回。 |
|
error_msg |
String |
错误描述。 |
状态码:405
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码,失败时返回。 |
|
error_msg |
String |
错误描述。 |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码,失败时返回。 |
|
error_msg |
String |
错误描述。 |
状态码:503
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码,失败时返回。 |
|
error_msg |
String |
错误描述。 |
请求示例
POST /v1/a4da8115c9d8464ead3a38309130523f/app-groups/656582710889807872/apps
{
"items" : [ {
"name" : "7-Zip File Manager",
"version" : "19.0.0.0",
"command_param" : "",
"execute_path" : "C:\\Program Files\\7-Zip\\7zFM.exe",
"work_path" : "",
"icon_path" : "C:\\Program Files\\7-Zip\\7zFM.exe",
"icon_index" : 0,
"description" : "",
"publisher" : "Igor Pavlov",
"source_image_ids" : [ "5d411710-98ac-47b5-af7c-3ecf6a0514b5" ],
"source_type" : 2
} ]
}
响应示例
状态码:200
操作成功。
{
"count" : 1,
"items" : [ {
"id" : "656599335839993860",
"name" : "7-Zip File Manager",
"version" : "19.0.0.0",
"command_param" : "",
"execute_path" : "C:\\Program Files\\7-Zip\\7zFM.exe",
"work_path" : "",
"icon_path" : "C:\\Program Files\\7-Zip\\7zFM.exe",
"icon_index" : 0,
"description" : "",
"app_group_id" : "656582710889807872",
"state" : "NORMAL",
"tenant_id" : "26a0420e9e284569a23f1b2f7d9b5011",
"publish_at" : "2024-01-15T08:39:56.265Z",
"source_type" : 2,
"publisher" : "Igor Pavlov",
"sandbox_enable" : false
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
操作成功。 |
|
400 |
由于包含语法错误,当前请求无法被服务器理解。 |
|
401 |
鉴权失败。 |
|
403 |
没有操作权限。 |
|
404 |
找不到资源。 |
|
405 |
请求中指定的方法不被允许。 |
|
500 |
服务内部错误,具体返回错误码请参见错误码说明。 |
|
503 |
服务不可用。 |
错误码
请参见错误码。