Common Request Parameters

Last updated: 2020-03-04 10:51:16

Common request parameters are required in every API and will not be detailed in each API document unless necessary. They are required in each request for the request to be initiated properly. They always begin with an uppercase letter for distinction between API request parameters.

The following lists the specific common request parameters:

Name Type Description Required
Action String Name of the action-specific API. For example, if you want to call the DescribeProject API, then the `Action` parameter should be `DescribeProject`. Yes
Region String Region parameter. Parameter value for each region:
Beijing: bj, Guangzhou: gz, Shanghai: sh, Hong Kong (China): hk, North America: ca.
No
Timestamp UInt Current UNIX timestamp which records the time when an API request is initiated. Yes
Nonce UInt A random positive integer, which is used in conjunction with `Timestamp` to prevent replay attacks. Yes
SecretId String An ID that the user applies for on the TencentCloud API Key page. A `SecretId` is paired with a unique `SecretKey`, which is used to generate the request signature (`Signature`). For more information, see Signature Method. Yes
Signature String Request signature, which is used to verify the validity of the request. It is generated automatically by the system based on the input parameters. For more information, see Signature Method. Yes

Suppose you want to query the project list under the current account, a sample of the request would be as follows:

https://account.api.qcloud.com/v2/index.php?
Action=DescribeProject
&SecretId=xxxxxxx
&Timestamp=1465055529
&Nonce=59485
&Signature=mysignature
&<API request parameters>

A complete TencentCloud API request requires two types of parameters: common request parameters and API request parameters. 5 common request parameters are described above. For more information on API request parameters, please see API Request Parameters.