公共参数是青云提供的所有 API 请求都必需携带的参数。为减少内容重复，本章节将列举所有使用到的公共参数，且不在各 API 详情中再次列出。

参数名 描述 说明 是否必须

action

指令名称，每个 API 都有自己的名称，用来标识请求指令，例如 RunInstances。

详情请参见各 API 文档。

是

zone

区域 ID，当 API 请求是需要在某个具体的区域执行时，需要加上该参数。例如 pek3a。a

用户需根据实际环境进行填写。

  • pek3a：北京3区-A

  • pek3：北京3区(包括 pek3b/pek3c/pek3d)

  • sh1a：上海1区-A

  • gd2：广东2区(包括 gd2a/gd2b)

  • ap2a：亚太2区-A

是

time_stamp

请求串生成时间。

  • 这个时间为 UTC 时间，假设您的本地时间为北京时间 UTC+8，您需要将其转化为 UTC+0 的时间。

  • 格式 YYYY-MM-DDThh:mm:ssZ，例如 2013-08-27T13:58:35Z。

  • 具体格式可以参见 ISO8601。

是

access_key_id

申请的 API 密钥 ID。

例如 QYACCESSKEYIDEXAMPLE。

是

version

API 的版本号。

目前只支持版本号 1。

是

signature_method

签名所用哈希算法，目前支持 HmacSHA256 和 HmacSHA1。

-

是

signature_version

签名函数的版本号。

目前只支持版本号 1。

是

signature

请求消息的签名。

请参见签名方法。

是

limit

表示返回数据长度，默认为 20，最大 100。

请参见 参数说明。

否

offset

表示数据偏移量，默认为 0。

请参见 参数说明。

否

附录

offset & limit 参数说明

以 DescribeInstances 获取主机这个 API 为例，系统中主机的总数为 3 台。

  • 当 limit 为 20，offset 为 0 时，查询显示出所有的三台主机。结果如下所示。

    "instance_name": "",
"instance_name": "rtr-8vwgl9kv",
"instance_name": "tools",
"total_count": 3

  • 当 limit 为 20，offset 为 1 时，查询显示第 2，第 3 台主机。结果如下所示。

    "instance_name": "rtr-8vwgl9kv",
"instance_name": "tools",
"total_count": 3,

  • 当 limit 为 20，offset 为 2 时，查询显示第 3 台主机。结果如下所示。

    "instance_name": "tools",
"total_count": 3,

  • 当 limit 为 20，offset 大于 2 时，查询无主机显示。结果如下所示。

    {'action': 'DescribeInstancesResponse', 'instance_set': [], 'total_count': 3, 'ret_code': 0}

综上所述，offset 表示数据偏移量，默认为 0，表示从第 n+1 个查询结果开始显示。limit 表示返回数据长度，默认为 20，最大 100。取值为 10、20、50、100。

比如查询 101-199 号主机，此时可以设置 limit 为 100，offset 为 100。