公共参数

最近更新时间:2018-12-06 21:41:57

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

签名方法 v3

使用 TC3-HMAC-SHA256 签名方法时,公共参数需要统一放到 HTTP Header 请求头部中,如下:

参数名称 类型 必选 描述
X-TC-Action String 具体操作的指令接口名称,例如想要调用云服务器的查询实例列表接口,则 Action 参数即为 DescribeInstances。
X-TC-Region String 地域参数,用来标识希望操作哪个地域的数据。
X-TC-Timestamp Integer 当前 UNIX 时间戳,可记录发起 API 请求的时间。例如1529223702,如果与当前API服务器时间相差超过5分钟,会引起签名过期错误。
X-TC-Version String API 的版本。例如 2017-03-12。
Authorization String HTTP 标准身份认证头部字段,例如:
TC3-HMAC-SHA256 Credential=AKIDEXAMPLE/Date/service/tc3_request, SignedHeaders=content-type;host, Signature=fe5f80f77d5fa3beca038a248ff027d0445342fe2855ddc963176630326f1024
其中,
- TC3-HMAC-SHA256:签名方法,目前固定取该值;
- Credential:签名凭证,AKIDEXAMPLE 是 SecretId;Date 是 UTC 标准时间的日期,取值需要和公共参数 X-TC-Timestamp 换算的 UTC 标准时间日期一致;service为产品名,必须与调用的产品域名一致,例如cvm;
- SignedHeaders:参与签名计算的头部信息,content-type 和 host 为必选头部;
- Signature:签名摘要。
X-TC-Token String 临时证书所用的 Token ,需要结合临时密钥一起使用。临时密钥和 Token 需要到访问管理服务调用接口获取。长期密钥不需要 Token 。

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

https://cvm.tencentcloudapi.com/?Limit=10&Offset=0

Authorization: TC3-HMAC-SHA256 Credential=AKIDz8krbsJ5yKBZQpn74WFkmLPx3EXAMPLE/2018-10-09/cvm/tc3_request, SignedHeaders=content-type;host, Signature=5
da7a33f6993f0614b047e5df4582db9e9bf4672ba50567dba16c6ccf174c474
Content-Type: application/x-www-form-urlencoded
Host: cvm.tencentcloudapi.com
X-TC-Action: DescribeInstances
X-TC-Version: 2017-03-12
X-TC-Timestamp: 1539084154
X-TC-Region: ap-guangzhou

签名方法 v1

使用 HmacSHA1 和 HmacSHA256 签名方法时,公共参数需要统一放到请求串中,如下

参数名称 类型 必选 描述
Action String 具体操作的指令接口名称,例如想要调用云服务器的查询实例列表接口,则 Action 参数即为 DescribeInstances 。
Region String 地域参数,用来标识希望操作哪个地域的数据。
Timestamp Integer 当前 UNIX 时间戳,可记录发起 API 请求的时间。例如1529223702,如果与当前时间相差过大,会引起签名过期错误。
Nonce Integer 随机正整数,与 Timestamp 联合起来,用于防止重放攻击。
SecretId String 云API密钥上申请的标识身份的 SecretId,一个 SecretId 对应唯一的 SecretKey ,而 SecretKey 会用来生成请求签名 Signature。
Signature String 请求签名,用来验证此次请求的合法性,需要用户根据实际的输入参数计算得出。具体计算方法参见接口鉴权文档。
Version String API 的版本。例如 2017-03-12。
SignatureMethod String 签名方式,目前支持 HmacSHA256 和 HmacSHA1。只有指定此参数为 HmacSHA256 时,才使用 HmacSHA256 算法验证签名,其他情况均使用 HmacSHA1 验证签名。
Token String 临时证书所用的 Token ,需要结合临时密钥一起使用。临时密钥和 Token 需要到访问管理服务调用接口获取。长期密钥不需要 Token 。

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

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

地域列表

本产品所有接口 Region 字段的可选值如下表所示。如果接口不支持该表中的所有地域,则会在接口文档中单独说明。

区域 取值
亚太地区(曼谷) ap-bangkok
华北地区(北京) ap-beijing
西南地区(成都) ap-chengdu
西南地区(重庆) ap-chongqing
华南地区(广州) ap-guangzhou
华南地区(广州Open) ap-guangzhou-open
东南亚地区(中国香港) ap-hongkong
亚太地区(孟买) ap-mumbai
亚太地区(首尔) ap-seoul
华东地区(上海) ap-shanghai
华东地区(上海金融) ap-shanghai-fsi
华南地区(深圳金融) ap-shenzhen-fsi
东南亚地区(新加坡) ap-singapore
亚太地区(东京) ap-tokyo
欧洲地区(法兰克福) eu-frankfurt
欧洲地区(莫斯科) eu-moscow
美国东部(弗吉尼亚) na-ashburn
美国西部(硅谷) na-siliconvalley
北美地区(多伦多) na-toronto

如果有其他疑问,您也可以在问答社区中寻求帮助。前往问答社区 >