操作指南

最佳实践

运维指南

API 文档

公共参数

最近更新时间:2019-08-13 10:47:05

说明:

当前页面接口为旧版 API,未来可能停止维护,目前不展示在左侧导航。云服务器 API 3.0 版本接口定义更加规范,访问时延下降显著,建议使用 云服务器 API 3.0

公共参数是用于标识用户和接口鉴权目的的参数,如非必要,在每个接口单独的接口文档中不再对这些参数进行说明,但每次请求均需要携带这些参数,才能正常发起请求。

参数名称 是否必选 类型 描述
Action 具体操作的指令接口名称,例如想要调用 查询实例列表 接口,则 Action 参数即为 DescribeInstances。 String
Region 区域参数,用来标识希望操作哪个区域的实例。各区域的参数值为:
北京:ap-beijing,广州:ap-guangzhou,上海:ap-shanghai,中国香港:ap-hongkong,多伦多:na-toronto,硅谷:na-siliconvalley,新加坡:ap-singapore,上海金融:ap-shanghai-fsi,深圳金融:ap-shenzhen-fsi,广州Open专区:ap-guangzhou-open
查看所有 区域和可用区 列表,查看 查询地域列表 API 接口。
注意:1、正常情况下此参数是必须的,如无需传入,则会在相应接口中进行说明。
2、部分区域正在内测中,目前仅面向部分用户开放。
String
Timestamp 当前 UNIX 时间戳,可记录发起 API 请求的时间。 UInt
Nonce 随机正整数,与 Timestamp 联合起来, 用于防止重放攻击。 UInt
SecretId 云 API 密钥 上申请的标识身份的 SecretId,一个 SecretId 对应唯一的 SecretKey , 而 SecretKey 会用来生成请求签名 Signature。具体可参考 签名方法 页面。 String
Signature 请求签名,用来验证此次请求的合法性,需要用户根据实际的输入参数计算得出。计算方法可参考 签名方法 页面。 String
SignatureMethod 签名方式,目前支持 HmacSHA256 和 HmacSHA1。只有指定此参数为 HmacSHA256 时,才使用 HmacSHA256 算法验证签名,其他情况均使用 HmacSHA1 验证签名。签名计算方法可参考 签名方法 页面。 String
Token 临时证书所用的 Token,需要结合临时密钥一起使用。长期密钥不需要 Token。 String

假设用户想要查询广州地域的云服务器实例列表,则其请求链接的形式可能如下:

https://cvm.api.qcloud.com/v2/index.php?Action=DescribeInstances
&SecretId=xxxxxxx
&Region=ap-guangzhou
&Timestamp=1402992826
&Nonce=345122
&Signature=xxxxxxxx
&Version=2017-03-12

其中 Version 字段为用来表示 DescribeInstances 接口的版本的必传参数。