Common Request Parameters

Last updated: 2017-12-11 15:45:35

Common request parameters are the request parameters that are used by every API. Unless it is necessary, these parameters will not be described in the separate documents for each API. However, they need to be included in each request. The first letter of common request parameters are capitalized, to distinguish them from API request parameters.

Common request parameters are listed below:

Parameter Required Description Type
Action Yes The API name to be called. For example, if you want to call the DescribeInstances API, then the Action parameter is DescribeInstances. String
Region No This parameter indicates the region you want to operate the instances. The values for the region parameter are:
Beijing:ap-beijing, Guangzhou:ap-guangzhou, Shanghai:ap-shanghai, Hong Kong:ap-hongkong, Toronto:na-toronto, Silicon Valley:na-siliconvalley, Singapore:ap-singapore, Shanghai Finance:ap-shanghai-fsi, Shenzhen Finance:ap-shenzhen-fsi, Guangzhou open zone: ap-guangzhou-open
Click to view all Regions and Availability Zones,click to view DescribeRegions API introduce。
Note: 1. This parameter is required fot most cases. If it is not required, we will state that in the corresponding API doc.
2. Some regions are in trial period and only open for authorized users.
String
Timestamp Yes Current UNIX timestamp, which records the time when an API request is originated. UInt
Nonce Yes A random positive integer, used in conjunction with timestamp to prevent playback attacks. UInt
SecretId Yes The SecretId that indicates the identity requested on the Cloud API key. A SecretId corresponds to a unique SecretKey, which is used to generate a request signature. For details, refer to the Signature Mode page. String
Signature Yes Request signature, used to verify the legitimacy of the request, the system automatically generated based on input parameters. For details, refer to the Signature Mode page. String

For example, if you want to query the CVM instance list in Guangzhou, the request link should be:

https://cvm.api.qcloud.com/v2/index.php?
Action=DescribeInstances
&SecretId=xxxxxxx
&Region=ap-guangzhou
&Timestamp=1465055529
&Nonce=59485
&Signature=mysignature
&<API request parameters>

A complete request requires two types of request parameters: public request parameters and API request parameters. Only the aforementioned six public request parameters are listed here. For more information about API request parameters, refer to the API request parameters section.