跳到主要内容

API概述

概述​

  • 星界链向用户开放资源操作相关的API，我们的API是通过 HTTP GET 方式来进行调用的。
  • 在调用我们的API之前，您需要先在我们的控制台申请 API密钥 ， 包括 API密钥ID ( AccessKeyId ) 和 API密钥的私钥 ( AccessKeySecret)。
  • API密钥ID 将作为参数包含在每一个请求中发送；而 API密钥的私钥 负责生成请求串的签名，API密钥的私钥 需要被妥善保管，请勿外传。

机房Region​

  • 云服务以机房区域（Region）为单位部署，一个区域一般代表一个数据中心或者是一组低延时链路互联的数据中心，各个区域之间相互独立。（注：一个区域代表云服务的一个独立部署）。

API请求方式​

  • API 请求可以通过 HTTP 的 GET 请求发起。也可以使用星界链提供的 SDK。
  • 所有 API 参数都放在 URL 中提供。

API请求限制​

  • 单位时间内请求次数限制，用户需要合理安排。
  • 返回数据集长度限制，用户应当分批获取。

API请求类型​

我们的API请求主要分为 延迟请求 和 实时请求 两种。

  • 延迟请求 这种操作，在 API 响应中会返回 TaskId，普通用户可以通过查看资源状态来确认操作是否完成、成功还是失败。例如，在提交 RunInstance 操作之后，用户可以通过 DescribeInstances 来查看 Instance的状态以确认Instance是否创建成功。
  • 实时请求 这种操作会立刻返回操作结果。

API请求地址​

API请求样例​

  • 新版：

    https://api.chinac.com/v2/?Action=RunInstance&Region=cn-wuxi1&AccessKeyId=569f60d78a704c84920550b21577ae1b&Version=1.0&Date=2016-09-02T16%3A59%3A00%20%2B0800&Signature=JJ16Ph8pnOluwPULqudHGGNUf9IRPgScpiWrCHkvn%2Bw%3D&ImageId=i-sdddxxx&Volumes.0.Type=normal&PayType=ONDEMAND&Period=1&InstanceSeries=SERIES_STANDARD

  • 旧版：

    https://api.chinac.com/?Action=RunInstance&Region=cn-wuxi1&AccessKeyId=569f60d78a704c84920550b21577ae1b&Version=1.0&Date=2016-09-02T16%3A59%3A00%20%2B0800&Signature=JJ16Ph8pnOluwPULqudHGGNUf9IRPgScpiWrCHkvn%2Bw%3D&ImageId=i-sdddxxx&Volumes.0.Type=normal&PayType=ONDEMAND&Period=1&InstanceSeries=SERIES_STANDARD

为了方便查看，我们将文档中的请求都进行换行来显示:

https://api.chinac.com/v2/?Action=RunInstance
&Region=cn-wuxi1
&AccessKeyId=569f60d78a704c84920550b21577ae1b
&Version=1.0
&Date=2016-09-02T16%3A59%3A00%20%2B0800
&Signature=JJ16Ph8pnOluwPULqudHGGNUf9IRPgScpiWrCHkvn%2Bw%3D
&ImageId=i-sdddxxx
&Volumes.0.Type=normal
&PayType=ONDEMAND
&Period=1
&InstanceSeries=SERIES_STANDARD

API返回结构​

响应信息使用 JSON 格式，一般会返回以下的值：

  • 旧版：

    参数名称描述
    TaskId每个请求都有一个TaskId
    Code如果该请求执行失败，会返回一个Code，如果执行成功，没有Code，详情可见错误代码
    ErrorMessage如果有ErrorCode就会有对应的ErrorMessage，是对执行失败原因的描述
    Action每个请求都会返回对应的一个Action操作名称
    返回参数其他操作返回的参数见相关API操作文档

    对于查询类的操作，一般会返回一个 XXXSet（其中 XXX 部分是资源名称，比如 VolumeSet），放置所查询的资源的详细信息列表。

    对于创建类的操作，一般会返回一个 XXXId（如果创建单个资源，比如 InstanceId）或者 XXXs（资源名称复数，用于创建多个资源的场景，比如 Instances），指示所创建资源的 ID。

  • 新版：

    参数名称描述
    code如果该请求执行失败，会返回一个code，如果执行成功返回10000，详情可见错误代码
    message请求错误信息，是对执行失败原因的描述
    data返回通信数据，旧版的返回信息统一放到新版的data里面