Common Parameters

Last updated: 2020-06-05 21:29:29

Note:

This is a legacy API which has been hidden and will no longer be updated. We recommend using the new CVM API 3.0 which is standardized and faster.

Common parameters are used for user identification and API authentication. Unless necessary, these parameters are not discussed in each API document. A request must contain these parameters to be initiated successfully.

Parameter name Required Type Description
Action Yes The name of the API for the desired operation. For example, if you want to call APIQuery List of Instances, the Action parameter is DescribeInstances. String
Region No Region parameter, which is used to identify the region to which the instance you want to work with belongs. The values for the region parameter are:
Beijing: ap-beijing, Guangzhou: ap-guangzhou, Shanghai: ap-shanghai, Hongkong: 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 API Query Region List.
Notes: 1. TUnless otherwise specified in the API document, this parameter is required generally.
2. Some of the regions are under internal trial and are only available to certain users.
String
Timestamp Yes The current UNIX timestamp that records the time at which the API request was initiated. UInt
Nonce Yes A random positive integer that is used in conjunction with Timestamp to prevent replay attacks. UInt
SecretId Yes The SecretId which is used for identifying identity and applied for on Cloud API Key. A SecretId corresponds to a unique SecretKey, which is used to generate the request Signature. For more information, please see Signature Method. String
Signature Yes Request signature, which is used to verify the validity of the request. The signature must be calculated according to input parameters. For more information, please see Signature Method. String
SignatureMethod No Signature method. Currently supported methods are HmacSHA256 and HmacSHA1. HmacSHA256 method is used only when the parameter is specified as HmacSHA256, otherwise HmacSHA1 is used to verify signatures. For more information, please see Signature Method. String
Token No Token used for the temporary certificate. The token must be used together with the temporary key. A long-term key does not require a Token. String

For example, if a user wants to query the CVM instance list for Guangzhou, the request link may be as follows:

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

Version is the required parameter for the version of the API DescribeInstances.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help