接口:ContainerCreateOptions
属性
ArgsEscaped?
可选
ArgsEscaped:布尔型
默认值:false
命令已转义(仅限 Windows)
定义于
packages/extension-api/src/extension-api.d.ts:3241
AttachStderr?
可选
AttachStderr:布尔型
是否附加到 stderr
(默认值为 false)
定义于
packages/extension-api/src/extension-api.d.ts:3209
AttachStdin?
可选
AttachStdin:布尔型
是否附加到 stdin
(默认值为 false)
定义于
packages/extension-api/src/extension-api.d.ts:3199
AttachStdout?
可选
AttachStdout:布尔型
是否附加到 stdout
(默认值为 false)
定义于
packages/extension-api/src/extension-api.d.ts:3204
Cmd?
可选
Cmd:字符串
[]
要运行的命令,指定为字符串数组
定义于
packages/extension-api/src/extension-api.d.ts:3187
Detach?
可选
Detach:布尔型
在后台运行容器
定义于
packages/extension-api/src/extension-api.d.ts:3224
Domainname?
可选
Domainname:字符串
要用于容器的域名。
定义于
packages/extension-api/src/extension-api.d.ts:3141
Entrypoint?
可选
Entrypoint:字符串
|字符串
[]
容器的入口点,可以是字符串或字符串数组。
如果数组恰好包含一个空字符串([""]
),则入口点将重置为系统默认值(即,Docker 在 Containerfile 中没有 ENTRYPOINT 指令时使用的入口点)。
定义于
packages/extension-api/src/extension-api.d.ts:3194
Env?
可选
Env:字符串
[]
要在容器内部设置的环境变量列表,格式为 ["VAR=value", ...]
。没有 =
的变量将从环境中删除,而不是具有空值
定义于
packages/extension-api/src/extension-api.d.ts:3151
EnvFiles?
可选
EnvFiles:字符串
[]
要使用的环境文件
定义于
packages/extension-api/src/extension-api.d.ts:3156
ExposedPorts?
可选
ExposedPorts:对象
将端口映射到空对象的映射,格式为:{"<port>/<tcp|udp|sctp>": {}}
索引签名
[port
: 字符串
]: 对象
定义于
packages/extension-api/src/extension-api.d.ts:3167
HealthCheck?
可选
HealthCheck:HealthConfig
要执行的检查容器是否健康的测试。有关用法详细信息,请参阅 HealthConfig
定义于
packages/extension-api/src/extension-api.d.ts:3234
HostConfig?
可选
HostConfig:HostConfig
取决于我们运行的主机的容器配置
定义于
packages/extension-api/src/extension-api.d.ts:3172
Hostname?
可选
Hostname:字符串
要用于容器的主机名,作为有效的 RFC 1123 主机名
定义于
packages/extension-api/src/extension-api.d.ts:3136
Image?
可选
Image:字符串
创建容器时要使用的镜像的名称(或引用)
定义于
packages/extension-api/src/extension-api.d.ts:3177
Labels?
可选
Labels:对象
用户定义的键值元数据
索引签名
[label
: string
]: string
定义于
packages/extension-api/src/extension-api.d.ts:3161
MacAddress?
optional
MacAddress:string
容器的MAC地址。
定义于
packages/extension-api/src/extension-api.d.ts:3261
name?
optional
name:string
为容器分配指定名称。必须匹配正则表达式/?[a-zA-Z0-9][a-zA-Z0-9_.-]+
。如果未指定,平台将为容器分配唯一名称。
定义于
packages/extension-api/src/extension-api.d.ts:3114
NetworkConfig?
optional
NetworkConfig:NetworkingConfig
定义于
packages/extension-api/src/extension-api.d.ts:3285
NetworkDisabled?
optional
NetworkDisabled:boolean
禁用容器的网络连接。
定义于
packages/extension-api/src/extension-api.d.ts:3256
OnBuild?
optional
OnBuild:string
[]
ONBUILD
元数据,定义在镜像的 Dockerfile
中。
定义于
packages/extension-api/src/extension-api.d.ts:3266
OpenStdin?
optional
OpenStdin:boolean
是否打开 stdin
(默认false)。
定义于
packages/extension-api/src/extension-api.d.ts:3214
platform?
optional
platform:string
默认值:""
用于镜像查找的格式为 os[/arch[/variant]]
的平台。
当指定时,守护进程会检查请求的镜像是否存在于本地镜像缓存中,并带有给定的操作系统和体系结构,否则会返回 404
状态。
如果未设置该选项,则使用主机本机操作系统和体系结构在镜像缓存中查找镜像。但是,如果未传递平台,并且给定的镜像确实存在于本地镜像缓存中,但其操作系统或体系结构不匹配,则使用可用的镜像创建容器,并将警告添加到响应中的 Warnings
字段,例如;
WARNING: The requested image's platform (linux/arm64/v8) does not
match the detected host platform (linux/amd64) and no
specific platform was requested
定义于
packages/extension-api/src/extension-api.d.ts:3131
pod?
optional
pod:string
要在其中创建容器的 Pod。
定义于
packages/extension-api/src/extension-api.d.ts:3290
Shell?
optional
Shell:string
[]
当 RUN
、CMD
和 ENTRYPOINT
使用 shell 时,使用的 shell。
定义于
packages/extension-api/src/extension-api.d.ts:3283
start?
optional
start:boolean
立即启动容器(默认true)。
定义于
packages/extension-api/src/extension-api.d.ts:3229
StdinOnce?
optional
StdinOnce:boolean
在一个连接的客户端断开连接后关闭 stdin
(默认false)。
定义于
packages/extension-api/src/extension-api.d.ts:3219
StopSignal?
optional
StopSignal:string
作为字符串或无符号整数停止容器的信号。
定义于
packages/extension-api/src/extension-api.d.ts:3271
StopTimeout?
optional
StopTimeout:number
默认值:10
以秒为单位停止容器的超时时间。
定义于
packages/extension-api/src/extension-api.d.ts:3278
Tty?
optional
Tty:boolean
将标准流附加到 TTY,包括 stdin(如果未关闭)(默认false)。
定义于
packages/extension-api/src/extension-api.d.ts:3182
User?
optional
User:string
在容器内运行命令的用户。
定义于
packages/extension-api/src/extension-api.d.ts:3146
Volumes?
optional
Volumes:object
一个将容器内部挂载点路径映射到空对象的映射。
索引签名
[volume
: string
]: object
定义于
packages/extension-api/src/extension-api.d.ts:3246
WorkingDir?
optional
WorkingDir:string
要运行命令的工作目录。