公共请求参数

最近更新时间:2017-12-13 16:07:30

公共请求参数是每个接口都需要使用到的请求参数,如非必要, 在各个接口单独的文档中不再对这些参数进行说明, 但每次请求均需要携带这些参数, 才能正常发起请求。公共请求参数的首字母均为大写,以此区分于接口请求参数。

公共请求参数具体列表如下:

参数名称 是否必选 类型 描述
Action 具体操作的指令接口名称,例如想要调用查询实例列表接口,则Action参数即为DescribeCdbInstances。 String
Region 区域参数,用来标识希望操作哪个区域的实例。各区域的参数值为:
北京:ap-beijing,北京黑石:ap-beijing-bls,广州:ap-guangzhou,上海:ap-shanghai,香港:ap-hongkong,多伦多:na-toronto,硅谷:na-siliconvalley,新加坡:ap-singapore,上海金融:ap-shanghai-fsi,深圳金融:ap-shenzhen-fsi,广州open专区:ap-guangzhou-open,成都:ap-chengdu,法兰克福:eu-frankfurt,首尔:ap-seoul
查看所有区域和可用区列表,查看查询地域列表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://cdb.api.qcloud.com/v2/index.php?
Action=DescribeCdbInstances
&SecretId=xxxxxxx
&Region=ap-guangzhou
&Timestamp=1465055529
&Nonce=59485
&Signature=mysignature
&SignatureMethod=HmacSHA256
&<接口请求参数>

一个完整的请求需要两类请求参数:公共请求参数和接口请求参数。这里只列出了上述6个公共请求参数,并未列出接口请求参数,有关接口请求参数的说明可见接口请求参数小节。