API概览

本产品(Eci/2018-08-08)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

地域

API

标题

API概述

DescribeRegions 查询可以使用的阿里云地域和可用区 查询弹性容器实例支持的地域和可用区信息。

容器组

API

标题

API概述

CreateContainerGroup 创建一个容器组 调用CreateContainerGroup创建一个ECI实例(即容器组)。
UpdateContainerGroup 更新一个容器组 更新实例。
DescribeContainerGroups 批量查询容器组信息 调用DescribeContainerGroups批量查询ECI实例的信息。
DescribeContainerGroupStatus 批量查询容器组状态 调用DescribeContainerGroupStatus批量查询ECI实例的状态。
DescribeContainerGroupEvents 查询容器组事件列表 调用DescribeContainerGroupEvents批量查询ECI实例的事件信息。
ResizeContainerGroupVolume 扩容容器组的数据卷 调用ResizeContainerGroupVolume扩容指定ECI实例挂载的云盘数据卷。
RestartContainerGroup 重启一个容器组 调用RestartContainerGroup重启一个ECI实例。
DeleteContainerGroup 删除一个容器组 调用DeleteContainerGroup删除一个ECI实例。

容器

API

标题

API概述

ExecContainerCommand 在容器内部执行命令 调用ExecContainerCommand在容器内部执行命令。
DescribeContainerLog 获取容器日志信息 调用DescribeContainerLog获取容器组内某个容器的日志信息。
CommitContainer 创建CommitContainer任务 调用CommitContainer接口创建异步任务,将ECI实例中的指定容器保存为镜像,并推送至阿里云ACR的镜像仓库中。
DescribeCommitContainerTask 查询CommitContainer任务详情 调用DescribeCommitContainerTask查询CommitContainer任务的详情。

镜像缓存

API

标题

API概述

CreateImageCache 创建一个镜像缓存 调用CreateImageCache接口创建一个镜像缓存,以便后续创建ECI实例可以加速镜像拉取,减少实例启动耗时。
DeleteImageCache 删除一个镜像缓存 调用DeleteImageCache删除一个镜像缓存。
UpdateImageCache 更新一个镜像缓存 调用UpdateImageCache更新一个镜像缓存。
DescribeImageCaches 批量查询镜像缓存信息 调用DescribeImageCaches批量查询镜像缓存信息。

数据缓存

API

标题

API概述

CreateDataCache 创建数据缓存 创建一个数据缓存。
DescribeDataCaches 查询数据缓存 查询数据缓存信息。
UpdateDataCache 更新数据缓存 更新一个数据缓存。
CopyDataCache 拷贝数据缓存 将数据缓存从一个地域拷贝到另一个地域。
DeleteDataCache 删除数据缓存 删除一个数据缓存。

虚拟节点

API

标题

API概述

CreateVirtualNode 创建一个虚拟节点 调用CreateVirtualNode创建一个虚拟节点(VNode),用于对接自建Kubernetes集群,使其可以扩展资源到ECI。
DeleteVirtualNode 删除一个虚拟节点 调用DeleteVirtualNode删除一个虚拟节点。
UpdateVirtualNode 更新一个虚拟节点 调用UpdateVirtualNode更新一个虚拟节点的属性。
DescribeVirtualNodes 批量查询虚拟节点信息 调用DescribeVirtualNodes批量查询虚拟节点的详细信息。

监控

API

标题

API概述

DescribeContainerGroupMetric 查询一个ECI实例的监控数据 调用DescribeContainerGroupMetric查询一个ECI实例的监控数据。
DescribeMultiContainerGroupMetric 查询多个ECI实例的监控数据 调用DescribeContainerGroupMetric查询一个ECI实例的监控数据。

运维操作

API

标题

API概述

CreateInstanceOpsTask 创建运维任务 调用CreateInstanceOpsTask创建一个运维任务。
DescribeInstanceOpsRecords 查询运维任务信息 调用DescribeInstanceOpsRecords查询运维任务信息。

标签

API

标题

API概述

TagResources ECI资源绑定标签 调用TagResources为指定的ECI资源绑定标签。
ListTagResources 查询ECI资源绑定的标签信息 调用ListTagResources查询ECI资源绑定的标签信息。
UntagResources ECI资源解绑标签 调用UntagResources为指定的ECI资源解绑标签。

其他接口

API

标题

API概述

ListUsage 查询权益配额 调用ListUsage查询指定地域的权益配额,包括已使用量和使用上限。
DescribeContainerGroupPrice 查询实例价格 查询ECI实例的价格。
DescribeAvailableResource 查询可用ECS实例规格 调用DescribeAvailableResource查询指定地域和可用区下可售ECS实例规格族。