QingCloud 文档 – API文档 - kaiyun官方网站下载手机网页

Development_docs: 概述

Mon, 01 Jan 0001 00:00:00 +0000

开·云app官方版下载QingCloud向用户开放所有资源操作相关的API，我们的API是通过 HTTPS GET 方式来进行调用的。在调用我们的API之前，您需要先在我们的控制台申请API密钥，包括 API密钥ID ( access_key_id ) 和 API密钥的私钥 ( secret_access_key )。 API密钥ID 将作为参数包含在每一个请求中发送；而 API密钥的私钥负责生成请求串的签名，API密钥的私钥需要被妥善保管，请勿外传。

API 请求限制

配额限制: 为了保证用户能合理地使用 API ，我们对每位用户的 API 访问配额进行了限制，初始用户： 2000次 / 3600秒，未来会开放更高的配额。

返回数据集长度限制: 当获取资源列表时，系统返回的最大数据长度是 100 ，即便你传了更大的 limit ，所以如果你需要获取很多的数据时，请根据返回的 total_sum （根据请求时的过滤参数，得到的数据集总数）分批获取。

API 请求结构

Name	Description	Notes
API入口	API 调用的 webservice 入口	我们的API入口目前统一为：https://api.qingcloud.com/iaas/
公共参数	每个 API 调用都需要包含公共参数	详情可见公共参数
指令名称	API指令的名称 ( action )，例如 DescribeInstances 等。	完整的指令名称列表请参见 API指令列表。
指令参数	指令参数请参见每个指令的相关文档。

API 请求样例

一个典型的API请求如下所示，这是一个 DescribeInstances 的API请求:

https://api.qingcloud.com/iaas/?access_key_id=QYACCESSKEYIDEXAMPLE&action=DescribeInstances&expires=2013-08-29T07%3A42%3A25Z&limit=20&signature_method=HmacSHA256&signature_version=1&status.1=running&time_stamp=2013-08-29T06%3A42%3A25Z&version=1&zone=pek3b&signature=ihPnXFgsg5yyqhDN2IejJ2%2Bbo89ABQ1UqFkyOdzRITY%3D

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

https://api.qingcloud.com/iaas/?access_key_id=QYACCESSKEYIDEXAMPLE
&action=DescribeInstances
&expires=2013-08-29T07%3A42%3A25Z
&limit=20
&signature_method=HmacSHA256
&signature_version=1
&status.1=running
&time_stamp=2013-08-29T06%3A42%3A25Z
&version=1
&zone=pek3b
&signature=ihPnXFgsg5yyqhDN2IejJ2%2Bbo89ABQ1UqFkyOdzRITY%3D

API 返回结构

Name	Description	Notes
指令名称	API 返回的指令名称 ( action )，例如 DescribeInstancesResponse 等。	API 返回的指令名称一般以 “API 请求指令名称” + “Response” 来表示。
返回码	返回码 ( ret_code ) 用来表示API请求的返回值，当ret_code = 0时表示API请求正常，ret_code != 0时表示API请求错误。	详情可见错误码
返回参数	返回参数请参见每个指令的相关文档。

API 返回样例

API的返回结果为 JSON 结构，这是一个 DescribeInstances 的API请求返回:

{
  "action":"DescribeInstancesResponse",
  "instance_set":[
    {
      "vcpus_current":1,
      "instance_id":"i-ogbndull",
      "vxnets":[
        {
          "vxnet_name":"primary vxnet",
          "vxnet_type":1,
          "vxnet_id":"vxnet-0",
          "nic_id":"52:54:ef:0c:ed:66",
          "private_ip":"10.50.13.54"
        }
      ],
      "memory_current":1024,
      "sub_code":0,
      "transition_status":"",
      "instance_name":"",
      "instance_type":"c1m1",
      "create_time":"2013-08-28T14:26:03Z",
      "status":"running",
      "status_time":"2013-08-28T14:26:03Z",
      "image":{
        "processor_type":"64bit",
        "platform":"linux",
        "image_size":20,
        "image_name":"CentOS 6.4 64bit",
        "image_id":"centos64x64",
        "os_family":"centos",
        "provider":"system"
      },
      "description":null
    }
  ],
  "ret_code":0,
  "total_count":1
}

API 请求类型

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

延迟请求: 对于耗时请求，无法实时返回执行结果，例如 RunInstances 等。这些请求将以任务形式提交给QingCloud后台执行，并会在API请求返回中返回任务ID ( job_id )。这种情况下，用户可以通过查看资源状态来判断任务是否执行完成。例如，在提交 RunInstances 操作之后，用户可以通过 DescribeInstances 来查看 Instance 的状态以确认 Instance 是否创建成功。

实时请求: 对于非耗时请求，会直接返回操作结果。

Development_docs: 公共参数

Mon, 01 Jan 0001 00:00:00 +0000

公共参数是所有 API 请求都必需的参数。

注解

为减少内容重复，公共参数就不在各 API 详情中列出了。

公共参数:

Name	Description	Notes
action	每个 API 都有自己的 action，用来标识所请求指令。例如 RunInstances。	完整的指令名称列表请参见 API指令列表。
zone	区域 ID，当 API 请求是需要在某个具体的区域执行时，需要加上该参数。例如 pek3a。	目前支持的区域 ID 有： pek3a：北京3区-A pek3：北京3区(包括 pek3b/pek3c/pek3d) sh1a：上海1区-A gd2：广东2区(包括 gd2a/gd2b) ap2a：亚太2区-A
time_stamp	请求串生成时间，格式为 YYYY-MM-DDThh:mm:ssZ，例如”2013-08-27T13:58:35Z”，具体格式可以参见 ISO8601.	这个时间为 UTC 时间，假设您的本地时间为北京时间 UTC+8 ，您需要将其转化为 UTC+0 的时间。
access_key_id	申请的 API密钥ID，例如”QYACCESSKEYIDEXAMPLE”。
version	API的版本号，目前只支持版本号为 1。
signature_method	签名所用哈希算法，目前支持 HmacSHA256 和 HmacSHA1。
signature_version	签名函数的版本号，目前只支持版本号为 1。
signature	请求消息的签名，请参见签名方法

请求样例:

https://api.qingcloud.com/iaas/?access_key_id=QYACCESSKEYIDEXAMPLE

&action=RunInstances

&count=1

&time_stamp=2013-08-27T13%3A58%3A35Z

&image_id=centos64x64

&instance_type=small_b

&signature_method=HmacSHA256

&signature_version=1

&version=1

&zone=pek3a

&signature=xMFvKenlbAAc0jGJ0iBHUhzh/wOBu3B8hypk+fTThFY=

Development_docs: 签名方法

Mon, 01 Jan 0001 00:00:00 +0000

这里介绍 API 请求中签名 ( signature ) 的生成方法。您可以根据实际情况选择使用 API 密钥 或 IAM 身份来完成签名。

API 密钥签名

您需要先在控制台创建API密钥，获得 accesss_key_id 和 secret_access_key，这里我们假设

access_key_id = 'QYACCESSKEYIDEXAMPLE'
secret_access_key = 'SECRETACCESSKEY'

例如我们的请求参数如下:

{
  "count":1,
  "vxnets.1":"vxnet-0",
  "zone":"pek3a",
  "instance_type":"small_b",
  "signature_version":1,
  "signature_method":"HmacSHA256",
  "instance_name":"demo",
  "image_id":"centos64x86a",
  "login_mode":"passwd",
  "login_passwd":"QingCloud20130712",
  "version":1,
  "access_key_id":"QYACCESSKEYIDEXAMPLE",
  "action":"RunInstances",
  "time_stamp":"2013-08-27T14:30:10Z"
}

注解

你可以使用上述的 AccessKey 和 Request 调试你的代码，当得到跟后面一致的签名结果后(即表示你的代码是正确的)，可再换为你自己的 AccessKey 和其他 API 请求。

签名步骤

1. 按参数名进行升序排列

排序后的参数为:

{
  "access_key_id":"QYACCESSKEYIDEXAMPLE",
  "action":"RunInstances",
  "count":1,
  "image_id":"centos64x86a",
  "instance_name":"demo",
  "instance_type":"small_b",
  "login_mode":"passwd",
  "login_passwd":"QingCloud20130712",
  "signature_method":"HmacSHA256",
  "signature_version":1,
  "time_stamp":"2013-08-27T14:30:10Z",
  "version":1,
  "vxnets.1":"vxnet-0",
  "zone":"pek3a"
}

2. 对参数名称和参数值进行URL编码

编码后的请求串为:

{
  "access_key_id":"QYACCESSKEYIDEXAMPLE",
  "action":"RunInstances",
  "count":1,
  "image_id":"centos64x86a",
  "instance_name":"demo",
  "instance_type":"small_b",
  "login_mode":"passwd",
  "login_passwd":"QingCloud20130712",
  "signature_method":"HmacSHA256",
  "signature_version":1,
  "time_stamp":"2013-08-27T14%3A30%3A10Z",
  "version":1,
  "vxnets.1":"vxnet-0",
  "zone":"pek3a"
}

警告

编码时空格要转换成 “%20” , 而不是 “+”

警告

转码部分的字符要用大写，如 ”:” 应转成 “%3A”，而不是 “%3a”

3. 构造URL请求

参数名和参数值之间用 “=” 号连接，参数和参数之间用 “＆” 号连接，构造后的URL请求为

access_key_id=QYACCESSKEYIDEXAMPLE&action=RunInstances&count=1&image_id=centos64x86a&instance_name=demo&instance_type=small_b&login_mode=passwd&login_passwd=QingCloud20130712&signature_method=HmacSHA256&signature_version=1&time_stamp=2013-08-27T14%3A30%3A10Z&version=1&vxnets.1=vxnet-0&zone=pek3a

4. 构造被签名串

被签名串的构造规则为: 被签名串 = HTTP请求方式 + “\n” + uri + “\n” + url 请求串

警告

“\n” 是换行符，不要将 “\” 转义。也就是说，不要用 “\n” ，有些语言，比如 php 和 ruby ，请用 “\n” , 而不是 ‘\n’

假设 HTTP 请求方法为 GET 请求的uri路径为 “/iaas/” , 则被签名串为

GET\n/iaas/\naccess_key_id=QYACCESSKEYIDEXAMPLE&action=RunInstances&count=1&image_id=centos64x86a&instance_name=demo&instance_type=small_b&login_mode=passwd&login_passwd=QingCloud20130712&signature_method=HmacSHA256&signature_version=1&time_stamp=2013-08-27T14%3A30%3A10Z&version=1&vxnets.1=vxnet-0&zone=pek3a

5. 计算签名

计算被签名串的签名 signature。

将API密钥的私钥 ( secret_access_key ) 作为key，生成被签名串的 HMAC-SHA256 或者 HMAC-SHA1 签名，更多信息可参见 RFC2104
将签名进行 Base64 编码
将 Base64 编码后的结果进行 URL 编码

警告

当 Base64 编码后存在空格时，不要对空格进行 URL 编码，而要直接将空格转为 “+”

以 Python (版本 2.7) 代码为例 (其他语言类似，需要使用 sha256 + base64 编码，最后需要再进行 URL 编码，URL 编码时需要将原有的空格 ” ” 转为 “+”)

import base64
import hmac
import urllib
from hashlib import sha256

# 前面生成的被签名串
string_to_sign = 'GET\n/iaas/\naccess_key_id=QYACCESSKEYIDEXAMPLE&action=RunInstances&count=1&image_id=centos64x86a&instance_name=demo&instance_type=small_b&login_mode=passwd&login_passwd=QingCloud20130712&signature_method=HmacSHA256&signature_version=1&time_stamp=2013-08-27T14%3A30%3A10Z&version=1&vxnets.1=vxnet-0&zone=pek3a'
h = hmac.new(secret_access_key, digestmod=sha256)
h.update(string_to_sign)
sign = base64.b64encode(h.digest()).strip()
signature = urllib.quote_plus(sign)

6. 添加签名

将签名参数附在原有请求串的最后面。最终的HTTP请求串为(为了查看方便，我们人为地将参数之间用回车分隔开)

access_key_id=QYACCESSKEYIDEXAMPLE
&action=RunInstances
&count=1
&image_id=centos64x86a
&instance_name=demo
&instance_type=small_b
&login_mode=passwd
&login_passwd=QingCloud20130712
&signature_method=HmacSHA256
&signature_version=1
&time_stamp=2013-08-27T14%3A30%3A10Z
&version=1
&vxnets.1=vxnet-0
&zone=pek3a
&signature=byjccvWIvAftaq%2BoublemagH3bYAlDWxxLFAzAsyslw%3D

完整的请求URL为(为了查看方便，我们人为地将参数之间用回车分隔开)

https://api.qingcloud.com/iaas/?access_key_id=QYACCESSKEYIDEXAMPLE
&action=RunInstances
&count=1
&image_id=centos64x86a
&instance_name=demo
&instance_type=small_b
&login_mode=passwd
&login_passwd=QingCloud20130712
&signature_method=HmacSHA256
&signature_version=1
&time_stamp=2013-08-27T14%3A30%3A10Z
&version=1
&vxnets.1=vxnet-0
&zone=pek3a
&signature=byjccvWIvAftaq%2BoublemagH3bYAlDWxxLFAzAsyslw%3D

实际URL为

https://api.qingcloud.com/iaas/?access_key_id=QYACCESSKEYIDEXAMPLE&action=RunInstances&count=1&image_id=centos64x86a&instance_name=demo&instance_type=small_b&login_mode=passwd&login_passwd=QingCloud20130712&signature_method=HmacSHA256&signature_version=1&time_stamp=2013-08-27T14%3A30%3A10Z&version=1&vxnets.1=vxnet-0&zone=pek3a&signature=byjccvWIvAftaq%2BoublemagH3bYAlDWxxLFAzAsyslw%3D

IAM 身份签名

您需要先到IAM控制面板创建一个基于特定信任载体类型的身份，并将身份绑定到 API 执行设备上。

这里我们假设您的 API 执行设备为 QingCloud 广东 2 区 id 为 i-7lchv5u3 的云服务器：

1. 获取 IAM 身份的临时凭证

在云服务器中执行如下命令，即可取得身份的临时凭证：

curl -i -H "Accept: application/json" http://169.254.169.254/latest/meta-data/security-credentials

返回信息：

"{\"jti\":\"0z7dO3oN03byx1CepBDTyl\",\"id_token\":\"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhY3IiOiIxIiwiYXVkIjoiaWFtIiwiYXpwIjoiaWFtIiwiY29ucyI6ImFkbWluIiwiY3VpZCI6ImlhbXItejU3dm42anIiLCJlaXNrIjoieUxjcFViRXZVOWZQZmJSQTA2eUFQMUtMS21keVpoX1JueDJmNmRmeFZZZz0iLCJleHAiOjE1OTAzMTk1MjMsImlhdCI6MTU5MDMxNTkyMywiaXNzIjoic3RzIiwianRpIjoiMHo3ZE8zb04wM2J5eDFDZXBCRFR5bCIsIm5iZiI6MCwib3JnaSI6ImFwcC0xMjM0NTY3OCIsIm93dXIiOiJ1c3ItQ29qOGFIZ24iLCJwcmVmIjoicXJuOnFpbmdjbG91ZDppYW06Iiwicm91ciI6InVzci1Db2o4YUhnbiIsInJ0eXAiOiJyb2xlIiwic3ViIjoic3RzIiwidHlwIjoiSUQifQ.YrCnvySApej2zHsn9cfn3D7tgOahDzeTP1TRBVMZ_3TyToo-H7hB2_mx_J_Qy1NY5K-WykYE4NFxqVN7PqsnAmskqAnRM2D7Gza_PffO7ajEJhtVF7Fo7nsmPKs7y1kryQ2Rvj3ABBJThHjQDtYVsk_pLUio5P0Nl9zb1sSswN4\",\"access_key\":\"0z7dO3oN03byx1CepBDTyl\",\"secret_key\":\"5qlKnUc3esKJp3G\",\"expiration\":1590319523}"

为了查看方便，我们人为地将参数之间用回车分隔开：

"jti":"0z7dO3oN03byx1CepBDTyl",
"id_token":"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhY3IiOiIxIiwiYXVkIjoiaWFtIiwiYXpwIjoiaWFtIiwiY29ucyI6ImFkbWluIiwiY3VpZCI6ImlhbXItejU3dm42anIiLCJlaXNrIjoieUxjcFViRXZVOWZQZmJSQTA2eUFQMUtMS21keVpoX1JueDJmNmRmeFZZZz0iLCJleHAiOjE1OTAzMTk1MjMsImlhdCI6MTU5MDMxNTkyMywiaXNzIjoic3RzIiwianRpIjoiMHo3ZE8zb04wM2J5eDFDZXBCRFR5bCIsIm5iZiI6MCwib3JnaSI6ImFwcC0xMjM0NTY3OCIsIm93dXIiOiJ1c3ItQ29qOGFIZ24iLCJwcmVmIjoicXJuOnFpbmdjbG91ZDppYW06Iiwicm91ciI6InVzci1Db2o4YUhnbiIsInJ0eXAiOiJyb2xlIiwic3ViIjoic3RzIiwidHlwIjoiSUQifQ.YrCnvySApej2zHsn9cfn3D7tgOahDzeTP1TRBVMZ_3TyToo-H7hB2_mx_J_Qy1NY5K-WykYE4NFxqVN7PqsnAmskqAnRM2D7Gza_PffO7ajEJhtVF7Fo7nsmPKs7y1kryQ2Rvj3ABBJThHjQDtYVsk_pLUio5P0Nl9zb1sSswN4",
"access_key":"0z7dO3oN03byx1CepBDTyl",
"secret_key":"5qlKnUc3esKJp3G",
"expiration":1590319523

2. 添加签名

将身份临时凭证中的 access_key 和 secret_key 按照前文 API 密钥同样的方法进行签名计算，然后将请求的 uri 路径改为 “/iam/”，最后在请求中附上 token 参数（参数值为临时凭证中的 id_token ）。

以 DescribeInstances 为例，最后请求的 URL 为（为了查看方便，我们人为地将参数之间用回车分隔开）:

https://api.qingcloud.com/iam/?access_key_id=0z7dO3oN03byx1CepBDTyl
&action=DescribeInstances
&req_id=35430c022b694133a6a758b62e21067b
&signature_method=HmacSHA256
&signature_version=2
&status.1=running
&status.2=stopped
&time_stamp=2020-05-25T07%3A20%3A28Z
&token=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhY3IiOiIxIiwiYXVkIjoiaWFtIiwiYXpwIjoiaWFtIiwiY29ucyI6ImFkbWluIiwiY3VpZCI6ImlhbXItejU3dm42anIiLCJlaXNrIjoieUxjcFViRXZVOWZQZmJSQTA2eUFQMUtMS21keVpoX1JueDJmNmRmeFZZZz0iLCJleHAiOjE1OTAzMTk1MjMsImlhdCI6MTU5MDMxNTkyMywiaXNzIjoic3RzIiwianRpIjoiMHo3ZE8zb04wM2J5eDFDZXBCRFR5bCIsIm5iZiI6MCwib3JnaSI6ImFwcC0xMjM0NTY3OCIsIm93dXIiOiJ1c3ItQ29qOGFIZ24iLCJwcmVmIjoicXJuOnFpbmdjbG91ZDppYW06Iiwicm91ciI6InVzci1Db2o4YUhnbiIsInJ0eXAiOiJyb2xlIiwic3ViIjoic3RzIiwidHlwIjoiSUQifQ.YrCnvySApej2zHsn9cfn3D7tgOahDzeTP1TRBVMZ_3TyToo-H7hB2_mx_J_Qy1NY5K-WykYE4NFxqVN7PqsnAmskqAnRM2D7Gza_PffO7ajEJhtVF7Fo7nsmPKs7y1kryQ2Rvj3ABBJThHjQDtYVsk_pLUio5P0Nl9zb1sSswN4
&verbose=0
&version=1
&zone=pekt3
&signature=o8TW8DUQ3wyHz5YSkpMd9fSj4pJ24U7%2Buf7CeWKMoQw%3D

实际 URL 为

https://api.qingcloud.com/iam/?access_key_id=0z7dO3oN03byx1CepBDTyl&action=DescribeInstances&req_id=35430c022b694133a6a758b62e21067b&signature_method=HmacSHA256&signature_version=2&status.1=running&status.2=stopped&time_stamp=2020-05-25T07%3A20%3A28Z&token=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhY3IiOiIxIiwiYXVkIjoiaWFtIiwiYXpwIjoiaWFtIiwiY29ucyI6ImFkbWluIiwiY3VpZCI6ImlhbXItejU3dm42anIiLCJlaXNrIjoieUxjcFViRXZVOWZQZmJSQTA2eUFQMUtMS21keVpoX1JueDJmNmRmeFZZZz0iLCJleHAiOjE1OTAzMTk1MjMsImlhdCI6MTU5MDMxNTkyMywiaXNzIjoic3RzIiwianRpIjoiMHo3ZE8zb04wM2J5eDFDZXBCRFR5bCIsIm5iZiI6MCwib3JnaSI6ImFwcC0xMjM0NTY3OCIsIm93dXIiOiJ1c3ItQ29qOGFIZ24iLCJwcmVmIjoicXJuOnFpbmdjbG91ZDppYW06Iiwicm91ciI6InVzci1Db2o4YUhnbiIsInJ0eXAiOiJyb2xlIiwic3ViIjoic3RzIiwidHlwIjoiSUQifQ.YrCnvySApej2zHsn9cfn3D7tgOahDzeTP1TRBVMZ_3TyToo-H7hB2_mx_J_Qy1NY5K-WykYE4NFxqVN7PqsnAmskqAnRM2D7Gza_PffO7ajEJhtVF7Fo7nsmPKs7y1kryQ2Rvj3ABBJThHjQDtYVsk_pLUio5P0Nl9zb1sSswN4&verbose=0&version=1&zone=pekt3&signature=o8TW8DUQ3wyHz5YSkpMd9fSj4pJ24U7%2Buf7CeWKMoQw%3D

Development_docs: 错误码

Mon, 01 Jan 0001 00:00:00 +0000

当请求发生错误时，服务器会返回错误码 ( ret_code ) 和错误信息 ( message )，完整的错误码如下表。

错误分为 客户端错误 ， 服务器端错误 ， 配置文件错误， License 错误 四种，如果是客户端错误，说明该错误是由用户提交的 API 引起的；如果是服务器端错误，说明该错误是由服务器端引起的；如果是配置文件错误，说明配置文件中的某项存在问题；如果是　License　错误，说明授权证书存在错误。

客户端错误:

错误代码	错误类型	提示
1100	消息格式错误	当缺少必要参数，或者参数值格式不正确时，会返回该错误。此时可以查看相关文档确认每个参数的格式是否正确。
1101	请求方法错误	当请求了不存在的方法，或者参数值不正确时，会返回该错误
1200	身份验证失败	当用户提供了不存在的　access_key_id　参数，或者　API　请求的签名不正确时，会返回该错误。此时可以检查　access_key_id　和　secret_access_key　是否配置正确，或者参考我们的签名文档签名方法检查是否签名有误。
1300	消息已过期	当用户提交的 time_stamp 参数时间过期(超过　60　秒)时会返回该错误。关于 time_stamp ，可以参考公共参数
1400	访问被拒绝	当用户试图访问不属于自己的资源，或者对于提交的操作没有权限，或者试图更改的资源处于不可更改的状态时等，会返回该错误。我们会在返回的错误信息里头提及错误原因。
1500	注册用户失败	当用户注册失败时，会返回该错误
1510	帐号已存在	当注册已存在的账号时，会返回该错误
1520	帐号格式不合法	当注册的账号格式不满足要求时，会返回该错误
1600	登录失败	当用户输入错误的登录信息时，会返回该错误
1610	找不到该用户	当用户提供了不存在的用户名时，会返回该错误
1620	密码不匹配	当用户提供了不匹配的密码时，会返回该错误
1630	重置密码失败	当用户重置密码不符合要求时，会返回该错误
1640	重置密码过于频繁	当用户重置密码过于频繁时，会返回该错误
1650	无效的密码重置　token	当用户重置密码　token　无效时，会返回该错误
1660	用户名或密码不匹配	当用户提供了不匹配的用户名密码时，会返回该错误
1661	用户未完成注册	当用户注册未完成时，会返回该错误
1662	用户已被禁止访问	当用户执行超出权限时，会返回该错误
2000	登录会话过期	当用户会话空闲过久时，会返回该错误，请重新登录
2100	找不到资源	当用户试图访问不存在的资源时，会返回该错误。
2110	资源已存在	当用户创建已存在的资源时，会返回该错误
2200	租赁资源失败	当用户租赁信息存在错误时，会返回该错误
2300	解除租赁失败	当用户解除租赁失败时，会返回该错误
2400	余额不足	当用户余额不足时，会返回该错误。
2500	超过配额	当用户试图创建的资源超过用户配额，或者短时间内的API访问请求超过配额限制，会返回该错误。 API　访问请求配额限制是以天为单位，当超过配置限额时，将会在在次日零点恢复。您可以通过提交工单的方式来向我们申请提高配额，并说明你申请的理由。
3300	无效的　API　模块	当用户使用了无效的　API　模块时，会返回该错误

License 错误:

错误代码	错误类型	提示
4000	无效的证书	当用户的证书失效时，会返回该错误
4001	授权证书已经过期	当用户的授权证书已经过期时，会返回该错误
4002	平台已有相同的授权证书	当用户的证书重复时，会返回该错误
4003	超出证书授权	当用户的当前宿云服务器的数量已超过授权证书的规定数量时，会返回该错误
4004	加载授权证书失败	当用户加载授权证书失败时，会返回该错误
4005	找不到授权证书	当用户没有有效的授权证书时，会返回该错误

服务器端错误:

错误代码	错误类型	提示
5000	内部错误	当服务器执行请求过程中，遇到未知错误时，会返回该错误信息。遇到这种错误，请及时与我们联系。
5100	服务器繁忙	当服务器执行超时，或者服务器负载过高无法完成请求时，会返回该错误信息。遇到这种错误，请稍后再尝试，或者及时与我们联系。
5200	资源不足	当我们后台计算资源不足以满足用户的创建需求时，会返回该错误信息。遇到这种错误，请及时与我们联系。
5300	服务更新中	当我们的后台服务正在更新时，会返回该错误信息。遇到这种错误，请稍后再尝试，或者及时与我们联系。
5400	存在依赖关系	当我们的后台服务正在更新时，会返回该错误信息。遇到这种错误，请稍后再尝试，或者及时与我们联系。
5500	Warehouse　服务未开启	当服务器　Warehouse　服务未开启时，会返回该错误信息。遇到这种错误，请及时与我们联系。
5600	不支持的硬盘类型	当用户向一个不支持加密的云服务器挂载加密硬盘时，会返回该错误信息。

配置文件错误:

错误代码	错误类型	提示
8000	命令参数验证失败	当用户在配置文件中提供了错误的参数时，会返回该错误
8001	配置文件中无任何镜像	当用户配置文件中无镜像时，会返回该错误
8002	配置文件中镜像在指定区不存在	当用户配置文件中的镜像在指定区不存在时，会返回该错误
8003	无效的集群设置	当用户配置文件提供了无效的集群设置时，会返回该错误
8004	缺少配置文件	当缺少相应配置文件时，会返回该错误

错误样例:

出现错误时，我们会返回错误码和详细的错误提示:

{
  "message":"PermissionDenied, instance [i-2aypaijz] is not running， can not be stopped",
  "ret_code":1400
}

Development_docs: API指令列表

Mon, 01 Jan 0001 00:00:00 +0000

这里列出了所有的API请求指令列表。

Development_docs: 通用部分

Mon, 01 Jan 0001 00:00:00 +0000