AIRIOT API 4.0

编排文件中添加指定服务并通过编排文件启动容器

POST

/api/docker/compose/service

容器编排管理

请求参数

Header 参数

Authorization

string

Token

可选

默认值:

Body 参数application/json

command

array[string]

可选

Whether the created service is external.
IsExternal bool json:"isExternal"

entrypoint

array[string]

入口点

可选

environment

array[string]

环境变量

可选

hostname

string

主机名

可选

image

object

容器启动的镜像

可选

name

string

可选

yaml:"name" json:"name"

tag

string

可选

yaml:"tag" json:"tag"

labels

array[string]

标签

可选

links

array[string]

链接

可选

name

string

可选

networks

array[string]

可选

Networks map[string]NetworkMap yaml:"networks,omitempty" // 加入的网络

path

string

路径

可选

ports

array[object (yml.Port) {3}]

暴露的端口号

可选

container

string

可选

yaml:"Container" json:"Container" // 内部容器的端口号

host

string

可选

yaml:"Host" json:"Host" // 外部主机的端口号

protocol

string

可选

yaml:"Protocol" json:"Protocol" // 协议

privileged

boolean

可选

service

string

可选

volumes

array[object (yml.VolumeMap) {3}]

挂载卷

可选

container

string

可选

yaml:"container" json:"container" // 内部容器的路径

host

string

可选

yaml:"host" json:"host" // 外部主机的路径

mode

string

可选

yaml:"mode" json:"mode" // 权限

示例

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/docker/compose/service' \
--header 'Authorization: {{ACCESS_TOKEN}}' \
--header 'Content-Type: application/json' \
--data-raw ''

返回响应

🟢200OK

application/json

Body

message

string

可选

示例

{
  "message": "string"
}

🟠400{error:{code:0,message:数据错误}}

🟠401{error:{code:0,message:未授权}}

🔴500{error:{code:0,message:服务器错误}}

修改于 2024-05-14 02:42:15

查询所有服务

查询编排文件中指定服务配置信息