1. 简介

欢迎阅读智算云 API 3.0 版本接口文档。

全新的 API 接口文档更加规范和全面，统一的参数风格和全面的错误码说明，帮助您顺利调用各个接口并顺利排查遇到的各种问题。

统一的 SDK/CLI 版本与 API 文档严格一致，给您带来简单快捷的使用体验。

1.1. 术语表

术语	服务类型	中文	说明
Region	region	地域	表示资源所在地域，每个地域包含一个或多个可用区。
Zone	zone	可用区	通常为了更方便管理一个服务器集群，或者为了降低故障影响面会把一个地域划分出不同的可用区。
Image	product	镜像	云服务器实例上的软件环境的拷贝。一般包括操作系统和已安装的软件。默认情况下云服务器使用镜像来创建。
ECS	ecs	云服务器实例	指代一台云服务器实例。在智算云中使用 ecsUuid 表示云服务器的 UUID。
EBS	ebs	云盘	云盘是一种公有云提供的存储产品。其支持在线扩容，通常不支持缩容。智算云中使用 ebsUuid 表示云盘的 UUID
EIP	eip	弹性公网 IP	弹性公网 IP 是公网 IP 的一种产品表现形式。与普通公网 IP 不同的是，弹性公网 IP 归属于用户账户而不是实例。弹性公网 IP 可以随时从云服务器上绑定和解绑，也可以单独删除。智算云中使用 eipUuid 表示弹性公网 IP 的 UUID。
ACKCS	ackcs	容器实例	代指一台容器实例。其唯一编码用 serviceUuid 表示
ACKCV	ackcv	容器存储	代指容器共享存储。其唯一编码用 volumeUuid 表示
ACKCI	ackci	容器镜像	代指容器用户自定义镜像。其唯一编码用 imageUuid 表示

智算云为了保持接口命名的一致性。特做如下约定：

云服务器实例在接口名称上统一为 Instance，如 DescribeInstances；云服务器的唯一 id 统一为 ecsUuid
云盘在接口名称上统一为 Disk，如 DescribeDisks；云盘的唯一 id 统一为 ebsUuid
弹性公网 IP 在接口名称上统一为 Network，如 DescribeNetworks；弹性公网 IPid 统一为 eipUuid

1.2. 计量计费

为了更好的使用 GPU 云服务器，避免造成 GPU 算力浪费和不可恢复性的数据丢失等问题，请您仔细阅读并关注以下信息。

平台提供【按时长】和【按固定时长】两种计费方式，可分别满足不同场景下的用户需求。【按固定时长计费方式】需要提前一次性支付对应购买时长的费用，价格相比按时长计费更低廉，建议对设备有长期稳定需求的客户使用此计费方式；【按时长计费方式】系统将按照主机的实际使用时长进行扣费，计费时间精确到秒，资源创建后每小时进行一次结算，建议对设备需求量不稳定的客户使用此计费方式。不同计费方式的计费模式、计量单位资源回收方式不同，具体如下：

1.2.1. 按固定时长模式

① 扣费方式：预付费，按照配置的服务器资源（主机配置、存储、网络带宽）和按固定时长时长，开机时一次性扣费。若余额不足，则购买失败。平台支持包年、包月两种固定时长计费方式。

② 计量单位：

包年：一年起购，从配置包年模式开机成功后开始计时，按照自然年方式进行计量，购买时长最小为 1 年。
包月：一月起购，从配置包月模式开机成功后开始计时，按照自然月方式进行计量，购买时长最小为 1 月。

③ 到期策略：支持【到期后自动续费】、【到期后自动删除】两种策略，默认采用【到期后自动删除】策略，按固定时长资源到期前您可以通过平台随时修改到期策略，修改后立即生效，如果配置为【到期后自动续费】策略，平台会在到期前 7 天自动进行续费，请保证账户余额充足，以免续费失败，导致资源到期后被删除，影响您的正常使用。

④ 回收机制：配置为【到期后自动删除】策略的按固定时长资源，在到期前您可以通过平台进行续费继续使用，资源到期后如果不续费，资源（主机、存储、网络带宽）将立即关机回收，且不可恢复。

1.2.2. 按时长模式

① 扣费方式：后付费，按秒计费，按小时结算。
② 计量单位：随时购买随时释放。
③ 回收机制：欠费自动关机后，资源会立即被删除，且不能恢复。
④ 注意事项：

关机不计费，请务必通过平台提供的【关机】功能进行关机。
正常关机后：
- 标准模式：云服务器释放不计费，云盘和网络正常计费；
- 计费模式：所有资源不释放，正常计费，下次开机不排队；
- 节省模式：云服务器和网络释放不计费，云盘正常计费。
禁止直接在操作系统中进行关机，否则平台会认为资源未被释放，仍正常进行计费。

1.3. 云服务器状态

资源类型	资源状态	涉及操作	资源状态说明
云服务器	Creating	创建	云服务器正在创建
云服务器	Running	创建、开机、重启、更配和重装系统	云服务器正在运行
云服务器	Stopping	关机	云服务器正在关机中
云服务器	Stopped	关机、资源状态同步	云服务器已关机
云服务器	Starting	开机	云服务器正在开机中
云服务器	Rebooting	重启	云服务器正在重启中
云服务器	Resetting	重装系统	云服务器正在重装系统
云服务器	changeModel	更配	云服务器正在更配
云服务器	Deleting	删除	云服务器正在删除中

1.4. 云盘状态

资源类型	资源状态	涉及操作	资源状态说明
云盘	Creating	创建	正在创建中。
云盘	Active	创建、挂载、卸载和扩容	最终态。创建完成后、挂载完成后、卸载完成后都为该种状态
云盘	Attaching	挂载	正在挂载中。
云盘	Detaching	卸载	正在卸载中。
云盘	Deleting	删除	正在删除中
云盘	Resizing	扩容	正在扩容中

1.5. 弹性公网 IP 状态

资源类型	资源状态	涉及操作	资源状态说明
弹性公网 IP	Creating	创建	正在创建中
弹性公网 IP	Associating	绑定	正在绑定中
弹性公网 IP	Associated	创建、绑定	已绑定
弹性公网 IP	Disassociating	解绑	正在解绑中
弹性公网 IP	Disassociated	创建、解绑	已解绑
弹性公网 IP	Deleting	删除	正在删除中
弹性公网 IP	Resizing	扩容	正在扩容中

1.6. 容器实例状态

资源类型	资源状态	涉及操作	资源状态说明
容器实例	Creating	创建	正在创建中
容器实例	Running	创建、开机、重启	已运行
容器实例	Starting	启动	正在启动
容器实例	Stopping	关机	正在关机
容器实例	Stopped	关机	已关机
容器实例	Rebooting	重启	正在重启
容器实例	Deleting	删除	正在删除
容器实例	Changing	更配	正在更配

1.7. 容器存储状态

资源类型	资源状态	涉及操作	资源状态说明
容器存储	Active	激活状态	随容器实例创建后为该状态
容器存储	Resizing	扩容	正在扩容中
容器存储	Deleting	删除	正在删除中

1.8. 容器镜像状态

资源类型	资源状态	涉及操作	资源状态说明
容器镜像	Creating	创建	正在扩容中
容器镜像	Active	创建	创建后为该状态
容器镜像	Deleting	删除	正在删除中

1.9. 资源类型

智算云对资源的类型有如下定义：

Ecs 表示云服务器
Ebs 表示云盘
Eip 表示弹性公网 IP
ACKCS 容器实例
ACKCV 容器存储
ACKCI 容器镜像

请求结构