公共参数

最近更新时间:2019-01-11 09:54:24

一个完整的腾讯云 API 请求需要两类请求参数:公共请求参数和接口请求参数。本文将介绍腾讯云 API 请求需要用到的 6 个公共请求参数,有关接口请求参数的详细说明请参见 接口请求参数 章节。
公共请求参数是每个接口都需要使用到的请求参数,开发者每次使用腾讯云 API 发送请求时都需要携带这些公共请求参数,否则会导致请求失败。公共请求参数的首字母均为大写,以此区分于接口请求参数。

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

参数名称 是否必选 类型 描述
Action String 具体操作的指令接口名称,例如想要调用联合身份临时凭证接口,GetFederationToken。
Region String 区域参数,用来标识希望调用哪个区域的 STS 服务。注意:1、目前仅对外开放 ap-guangzhou 和 ap-shanghai,其他区域还在内测中;2、缺省为 ap-guangzhou。
Timestamp UInt 当前 UNIX 时间戳,可记录发起 API 请求的时间。
Nonce UInt 随机正整数,与 Timestamp 联合起来, 用于防止重放攻击。
SecretId String 云API密钥 上申请的标识身份的 SecretId,一个 SecretId 对应唯一的 SecretKey , 而 SecretKey 会用来生成请求签名 Signature。具体可参考 签名方法 章节。
Signature String 请求签名,用来验证此次请求的合法性,需要用户根据实际的输入参数计算得出。计算方法可参考 签名方法 章节。
SignatureMethod String 签名方式,目前支持 HmacSHA256 和 HmacSHA1。只有指定此参数为 HmacSHA256 时,才使用 HmacSHA256 算法验证签名,其他情况均使用 HmacSHA1 验证签名。签名计算方法可参考 签名方法 页面。

使用示例

腾讯各云产品 API 请求链接中,公共请求参数的形式如下,以腾讯云 CVM 为例,假设用户想要查询广州地域的云服务器实例列表,则其请求链接的形式为:

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