Common Request Parameters

Recent Pages

Common Request Parameters

Last updated: 2024-11-19 15:18:35

Common parameters are required in every API for authenticating users and the APIs. Unless otherwise required, they will not be described in individual API documents.

Parameter	Type	Description	Required
Action	String	Command API name of a specific operation, such as DescribeInstances.	Yes
Region	String	Identifies the region where the instance you want to operate on resides. Valid values: gz: Guangzhou; sh: Shanghai; bj: Beijing; cd: Chengdu cq: Chongqing; hk: Hong Kong (China); sg: Singapore; th: Bangkok kr: Seoul; jp: Tokyo; de: Frankfurt in: Mumbai; usw: Silicon Vally; use: Virginia	Yes
Timestamp	UInt	Current Unix timestamp.	Yes
Nonce	UInt	A random positive integer, which is used in conjunction with `Timestamp` to prevent replay attacks.	Yes
SecretId	String	SecretId applied from Tencent Cloud which is used for identification. Each SecretId corresponds to a unique SecretKey, while SecretKey is used to generate request Signature. For more information, see Signature Method.	Yes
Signature	String	Request signature, which is used to verify the validity of the current request. For more information, see Signature Method.	Yes

The format of common request parameters in API request links is shown below. Take Tencent Cloud CVM as an example, suppose you need to query the list of CVM instances, the request link of "Action=DescribeInstance" should be:

https://domain/v2/index.php?Action=DescribeInstances
&SecretId=xxxxxxx
&Region=gz
&Timestamp=1402992826
&Nonce=345122
&Signature=mysignature
&instanceId=101

instanceId is a command parameter, and others are common parameters.