调用ExportContainerGroupTemplate导出用户创建ECI的模板。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ExportContainerGroupTemplate

系统规定参数。取值:ExportContainerGroupTemplate。

ContainerGroupId String eci-xxx

容器组ID。

RegionId String cn-hangzhou

实例所属地域ID。

返回数据

名称 类型 示例值 描述
RequestId String CADE4B4A-15EA-4DB1-BCE2-23CE4F59823F

请求ID,唯一标识。

Template Struct

容器组模板数据信息。

RegionId String cn-hangzhou

地域ID。

ZoneId String cn-hangzhou-h

实例所属的可用区编号。

SecurityGroupId String sg-bp118knl07ymorgzfhyw

安全组ID。

VSwitchId String vsw-bp1jrgfqqy54kg5hcf8bc

指定的虚拟交换机 ID。

ResourceGroupId String rg-acfm3us3oddylkq

资源组ID。

EipInstanceId String eip-xxx

弹性公网Ip。

ContainerGroupName String test

容器组名称。

InstanceType String ecs.sn1ne.large

实例规格。

Tags Array

标签。

Key String env

标签键。

Value String test

标签值。

Resources Struct

资源。

Cpu Float 1.0

CPU大小。

Memory Float 2.0

内存大小。

Spec Struct

规格信息。

RestartPolicy String Always

容器组的重启策略。

DnsPolicy String ClusterFirst

设置Pod的DNS 策略。

Volumes Array

数据卷列表。

Name String test-xxx

数据卷名称。

ConfigFile Struct

配置文件系统。

DefaultMode Integer 0

默认情况下在创建的文件上使用的模式位。必须是介于0和0777之间的值。默认值为0644。

Items Array

ConfigFile的列表。

Mode Integer 0

在此文件上使用的模式位必须为0到0777之间的值。如果未指定,将使用卷defaultMode。

Path String /usr/share/

相对文件路径。

Content String test content

配置文件内容 (32KB)。

EmptyDir Struct

共享文件系统。

SizeLimit String 20

设置数据卷大小限制。

Nfs Struct

网络文件系统。

Server String 3f9cd4a596-xxxxx.cn-shanghai.nas.aliyuncs.com

NFS 服务器地址。

Path String

NFS 数据卷路径。

ReadOnly Boolean false

默认值为 false。

InitContainers Array

Init容器列表。

Name String init-test

Init容器名称。

Image String nginx

镜像。

ImagePullPolicy String Always

镜像拉取策略。

Stdin Boolean false

此容器是否应在容器运行时为标准输入分配缓冲区。如果未设置,则容器中标准输入的读取值将导致EOF。默认为false。

StdinOnce Boolean true

当标准输入为True时,标准输入流将在多个附加会话中保持开启状态。如果StdinOnce设为True,标准输入在容器开启时被打开,在首个客户端附加到标准输入之前都为空,然后会一直保持开启状态,接收数据,直到客户端连接断开,此时标准输入被关闭,在容器重启前一直保持关闭状态。

Tty Boolean true

是否开启交互,默认为false,例如Command为 [“/bin/bash”] 时,需要设置为true。

WorkingDir String /test/

工作目录。

Env Array

环境变量。

Name String env

变量名。

Value String test

变量值。

ValueFrom Struct

环境变量值的来源。 如果值不为空,则无法使用。

FieldRef Struct

选择容器的字段。

FieldPath String status.podIP

指定的版本中选择字段的路径。目前只支持 status.podIP

Ports Array

暴露端口+协议,上限100。

Name String port-nginx

名称。

Protocol String TCP

该端口的IP协议。 支持“ TCP”和“ UDP”。 默认为TCP。

ContainerPort Integer 80

容器端口号。

VolumeMounts Array

数据卷挂载信息。

Name String test-empty

数据卷名称,同 Volume 中的 Name。

SubPath String /usr/local/bin

数据卷下的子目录,方便Pod将同一个Volume下不同目录挂载到容器不同目录挂载子目录。

MountPath String /usr/share/

挂载目录,容器的挂载目录下的内容被volume的内容直接覆盖,所以要慎用。

ReadOnly Boolean false

默认为False。

Command List [/bin/sh]

容器启动指令。

Args List [sleep 100]

容器启动参数,上限10。

SecurityContext Struct

实例运行的安全上下。

Sysctls Array

系统信息。

Name String kernel.msgmax

变量名。

Value String 0

变量值。

Resources Struct

资源信息。

Cpu Float 1.0

CPU大小。

Memory Float 2.0

内存大小。

Containers Array

容器列表。

Name String nginx-test

容器名称。

Image String nginx

镜像。

ImagePullPolicy String Always

镜像拉取策略。

Stdin Boolean false

此容器是否应在容器运行时为标准输入分配缓冲区。如果未设置,则容器中标准输入的读取值将导致EOF。默认为false。

StdinOnce Boolean true

当标准输入为true时,标准输入流将在多个附加会话中保持开启状态。如果StdinOnce设为true,标准输入在容器开启时被打开,在首个客户端附加到标准输入之前都为空,然后会一直保持开启状态,接收数据,直到客户端连接断开,此时标准输入被关闭,在容器重启前一直保持关闭状态。

Tty Boolean false

是否开启交互,默认为false,例如Command为 [“/bin/bash”] 时,需要设置为true。

WorkingDir String /usr/share/

容器工作目录。

Env Array

环境变量。

Name String Path

变量名。

Value String /usr/bin/

变量值。

ValueFrom Struct

环境变量值的来源。 如果值不为空,则无法使用。

FieldRef Struct

选择容器的字段。

FieldPath String status.podIP

指定的版本中选择字段的路径,目前只支持 status.podIP

Ports Array

暴露端口+协议,上限100。

Name String redis

名称。

Protocol String TCP

TCP/UDP。

ContainerPort Integer 6379

容器端口。

VolumeMounts Array

数据卷挂载信息。

Name String test-empty

数据卷名称,同 Volume 中的 Name。

SubPath String /usr/local/

数据卷下的子目录,方便Pod将同一个Volume下不同目录挂载到容器不同目录挂载子目录。

MountPath String /usr.share/

挂载目录,容器的挂载目录下的内容被volume的内容直接覆盖,所以要慎用。

ReadOnly Boolean false

默认为false。

Command List [/bin/sh]

容器启动命令,上限20,单个String,256个字符。

Args List [-c date; sleep 100]

容器启动参数,上限10。

SecurityContext Struct

实例运行的安全上下。

Sysctls Array

系统信息。

Name String kernel.msgmax

变量名。

Value String 0

变量值。

Resources Struct

资源列表信息。

Cpu Float 1.0

CPU大小。

Memory Float 2.0

内存大小。

ReadinessProbe Struct

Readiness探针。

InitialDelaySeconds Integer 5

检查开始执行的时间,以容器启动完成为起点计算。

PeriodSeconds Integer 1

检查执行的周期,默认为10秒,最小为1秒。

SuccessThreshold Integer 1

从上次检查失败后重新认定检查成功的检查次数阈值(必须是连续成功),默认为1。

FailureThreshold Integer 5

从上次检查成功后认定检查失败的检查次数阈值(必须是连续失败),默认为3。

TimeoutSeconds Integer 1

检查超时的时间,默认为1秒,最小为1秒。

Exec Struct

执行指令。

Command List [/bin/sh -c "touch /tmp/healthy; sleep 30; rm -rf /tmp/healthy; sleep 600"]

容器内检测的指令。

TcpSocket Struct

TcpSocket。

Port Integer 8080

TcpSocket检测的端口。

HttpGet Struct

HttpGet。

Scheme String HTTP

HTTP/HTTPS。

Path String /usr/local/

HttpGet检测的路径。

Port Integer 80

HttpGet检测的端口。

LivenessProbe Struct

存活探针。

InitialDelaySeconds Integer 5

检查开始执行的时间,以容器启动完成为起点计算。

PeriodSeconds Integer 3

检查执行的周期,默认为10秒,最小为1秒。

SuccessThreshold Integer 3

从上次检查失败后重新认定检查成功的检查次数阈值(必须是连续成功),默认为1。当前必须为1。

FailureThreshold Integer 5

从上次检查成功后认定检查失败的检查次数阈值(必须是连续失败),默认为3。

TimeoutSeconds Integer 1

检查超时的时间,默认为1秒,最小为1秒。

Exec Struct

执行指令。

Command List [/bin/sh -c "touch /tmp/healthy; sleep 30; rm -rf /tmp/healthy; sleep 600"]

容器内检测的命令。

TcpSocket Struct

TcpSocket。

Port Integer 8080

TcpSocket检测的端口。

HttpGet Struct

HttpGet。

Scheme String HTTP

HTTP/HTTPS。

Path String /usr/laocal/

HttpGet检测的路径。

Port Integer 80

HttpGet检测的端口号。

DnsConfig Struct

DNS配置信息。

Options Array

对象选项列表,每个对象由name和value(可选)构成。

Name String test-xxx

对象名。

Value String xiao

对象值。

NameServers List ['1.2.3.4', '2.2.12.3']

DNS 服务器 IP 地址列表。

Searches List ["svc.local.kubenetes", "svc.local.kubenetes"]

DNS 搜索域列表。

SecurityContext Struct

实例运行的安全上下文。

Sysctls Array

系统信息。

Name String kernel.msgmax

变量名。

Value String 0

变量值。

示例

请求示例

http(s)://eci.aliyuncs.com/?Action=ExportContainerGroupTemplate
&ContainerGroupId=eci-bp17da5olmkuagfrzurh
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML 格式

<Template>
    <SecurityGroupId>sg-bp118knl07ymorgzfhyw</SecurityGroupId>
    <Spec>
        <RestartPolicy>Always</RestartPolicy>
        <Containers>
            <Name>test</Name>
            <ImagePullPolicy>IfNotPresent</ImagePullPolicy>
            <ReadinessProbe>
                <Exec/>
                <TcpSocket/>
                <HttpGet/>
            </ReadinessProbe>
            <Image>busybox</Image>
            <SecurityContext/>
            <LivenessProbe>
                <Exec/>
                <TcpSocket/>
                <HttpGet/>
            </LivenessProbe>
            <Resources>
                <Memory>2</Memory>
                <Cpu>1</Cpu>
            </Resources>
        </Containers>
        <DnsPolicy>ClusterFirst</DnsPolicy>
    </Spec>
    <RegionId>cn-hangzhou</RegionId>
    <ResourceGroupId>rg-acfm3us3oddylkq</ResourceGroupId>
    <ZoneId>cn-hangzhou-h</ZoneId>
    <ContainerGroupName>test</ContainerGroupName>
    <VSwitchId>vsw-bp1jrgfqqy54kg5hcf8bc</VSwitchId>
    <Resources>
        <Cpu>1</Cpu>
        <Memory>2</Memory>
    </Resources>
</Template>
<RequestId>CADE4B4A-15EA-4DB1-BCE2-23CE4F59823F</RequestId>

JSON 格式

{
        "Template": {
                "SecurityGroupId": "sg-bp118knl07ymorgzfhyw",
                "Spec": {
                        "RestartPolicy": "Always",
                        "Containers": [
                                {
                                        "Name": "test",
                                        "ImagePullPolicy": "IfNotPresent",
                                        "ReadinessProbe": {
                                                "Exec": {},
                                                "TcpSocket": {},
                                                "HttpGet": {}
                                        },
                                        "Image": "busybox",
                                        "SecurityContext": {},
                                        "LivenessProbe": {
                                                "Exec": {},
                                                "TcpSocket": {},
                                                "HttpGet": {}
                                        },
                                        "Resources": {
                                                "Memory": 2.0,
                                                "Cpu": 1.0
                                        }
                                }
                        ],
                        "InitContainers": [],
                        "DnsPolicy": "ClusterFirst"
                },
                "RegionId": "cn-hangzhou",
                "ResourceGroupId": "rg-acfm3us3oddylkq",
                "ZoneId": "cn-hangzhou-h",
                "ContainerGroupName": "test",
                "VSwitchId": "vsw-bp1jrgfqqy54kg5hcf8bc",
                "Resources": {
                        "Cpu": 1.0,
                        "Memory": 2.0
                }
        },
        "RequestId": "CADE4B4A-15EA-4DB1-BCE2-23CE4F59823F"
}

错误码

访问错误中心查看更多错误码。