公共请求参数

最近更新时间:2017-12-12 11:37:20

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

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

注意:
文章中的接口实例以腾讯云 CVM 为例,各腾讯云产品的具体使用方式请对应实际产品。

名称 类型 描述 是否必选
Action String 具体操作的指令接口名称,例如想要调用 查询伸缩组列表 接口,则 Action 参数即为 DescribeInstances。
Region String 区域参数,用来标识希望操作哪个区域的实例。各区域的参数值为:
北京:bj,广州:gz,上海:sh,香港:hk,北美:ca。
例如想要操作北京地区的实例,则 Region 即为 bj。
注意:正常情况下此参数是必须的,如无需传入,则会在相应接口中进行说明。
Timestamp UInt 当前 UNIX 时间戳,可记录发起 API 请求的时间。
Nonce UInt 随机正整数,与 Timestamp 联合起来, 用于防止重放攻击。
SecretId String 云API密钥 上申请的标识身份的 SecretId,一个 SecretId 对应唯一的 SecretKey , 而 SecretKey 会用来生成请求签名 Signature。具体可参考 签名方法 页面。
Signature String 请求签名,用来验证此次请求的合法性,由系统根据输入参数自动生成。具体可参考 签名方法 页面。

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

https://cvm.api.qcloud.com/v2/index.php?
Action=DescribeInstances
&SecretId=xxxxxxx
&Region=gz
&Timestamp=1465055529
&Nonce=59485
&Signature=mysignature
&<接口请求参数>

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