说明:当前页面接口为旧版 API,未来可能停止维护,目前不展示在左侧导航。云服务器 API 3.0 版本接口定义更加规范,访问时延下降显著,建议使用 云服务器 API 3.0。
公共参数是用于标识用户和接口鉴权目的的参数, 如非必要, 在每个接口单独的接口文档中不再对这些参数进行说明, 但每次请求均需要携带这些参数, 才能正常发起请求。
名称 | 类型 | 描述 | 必选 |
---|---|---|---|
Action | String | 接口指令的名称,例如 DescribeInstances | 是 |
Region | String | 区域参数,用来标识希望操作哪个区域的实例。可选: bj:北京 gz:广州 sh:上海 hk:中国香港 ca:北美 sg:新加坡 usw:美西 cd:成都 de:德国 kr:韩国 shjr:上海金融 szjr:深圳金融 gzopen:广州OPEN | 是 |
Timestamp | UInt | 当前 UNIX 时间戳 | 是 |
Nonce | UInt | 随机正整数,与 Timestamp 联合起来, 用于防止重放攻击 | 是 |
SecretId | String | 由腾讯云平台上申请的标识身份的 SecretId 和 SecretKey, 其中 SecretKey 会用来生成 Signature 具体参考 接口鉴权 页面 | 是 |
Signature | String | 请求签名,用来验证此次请求的合法性, 具体参考 接口鉴权 页面 | 是 |
一个典型的接口请求如下,Action=DescribeInstance 表示查询云服务器实例的详情。
https://cvm.api.qcloud.com/v2/index.php?Action=DescribeInstances
&SecretId=xxxxxxx
&Region=gz
&Timestamp=1402992826
&Nonce=345122
&Signature=mysignature
&instanceId=101
其中 instanceId 为指令参数,其余为通用参数。