1. 请求结构

1.1. 服务地址

智算云提供统一的接口访问地址 https://ai.blsc.cn (opens in a new tab) 。

1.2. 通信协议

智算云的所有接口均可通过 HTTPS 进行通信，提供高安全性的通信通道。

1.3. 请求方法

支持的 HTTP 请求方法：

POST

POST 请求支持的 Content-Type 类型: application/json

POST 请求使用签名方法 v3（HmacSHA256）时不得超过 1MB。

1.4. 字符编码

当前智算云默认使用中文返回您需要的信息。

均使用 UTF-8 编码。

1.5. 返回结果

智算云使用统一的接口返回方式。通常返回的格式为

{
	"code": 200,
	"message": "成功创建云服务器",
	"data": ...
  }

属性名称	属性类型	说明
code	Integer	接口返回的状态码。状态码为 200 表示接口执行成功。非 200 表示失败。该状态码还会返回业务有关的数字。详见本文档最后章节
message	String	与状态码对应的中文说明
data	Object 或 Array	接口返回的业务数据

1.6. 异步任务

通常情况下对云服务器的操作是很费时的，为了让接口可以快速响应不影响别的操作，智算云提供的云服务器、云盘和弹性公网 IP 操作接口都是异步接口。接口调用后会立马返回一个异步任务结果。后续通过查询异步任务的 UUID 可以获取到该异步任务的执行情况。

以创建为例，当创建接口执行后会返回如下信息

{
  "code": 200,
  "message": "成功创建云服务器",
  "data": [
    {
      "errno": "0",
      "jobUuid": "72b88025f7d34b8ea90605cd557e2d8f",
      "success": false,
      "errmsg": "ok",
      "progress": 0.0,
      "type": "CreateDC2",
      "done": false,
      "resourceUuid": "ins-d6uvzs2y"
    }
  ]
}

data 中返回的内容就是异步信息，以下罗列出异步信息的各个属性含义

属性名	属性类型	说明
errno	String	异步任务错误号,默认 0 表示正在执行或执行成功
errmsg	String	异步任务状态信息。默认 ok 表示正在执行或执行成功
jobUuid	String	异步任务 UUID 号
type	String	异步任务名称
done	Boolean	true 表示异步任务执行完成，false 表示异步任务正在执行
success	Boolean	true 表示异步任务执行成功，false 表示异步任务执行失败或正在执行
resourceUuid	String	资源 UUID

通常情况下:

done 为 false，success 肯定为 false，表示异步任务正在执行。
done 为 true，success 为 false。表示异步任务执行完成，但是执行失败。
done 为 true，success 为 true。表示异步任务执行完成，并最终执行成功。

1.7. 智算云平台支持的服务类型

云服务器实例的服务类型为 ecs
云盘的服务类型为 ebs
弹性公网 IP 的服务类型为 eip

1.8. 分页说明

云服务器实例列表查询接口和云盘列表查询接口支持分页查询

通常分页查询接口支持页号 pageNum 和页大小 pageSize 两个参数，通过这两个参数界定分页范围。

pageNum 接收一个正整数值，从 1 开始。

pageSize 接收一个正整数,默认 200。

简介公共参数