Public Request Parameters

Last updated: 2017-07-25 11:14:29

PDF

Common request parameters are the parameters common to all APIs, and will not be discussed in each API document unless necessary. They are required in each request for the request to be initiated normally. The first letter of each common request parameter is in uppercase so that the parameter can be differentiated from API request parameters.

Common request parameters are as follows:

Name Type Description Required
Action String The name of the API for the desired operation. For example, if you want to call API Create Namespace, the Action parameter is CreateNamespace. Yes
Region String Region parameter, which is used to identify the region to which the instance you want to work with belongs. The parameter values for regions are as follows:
Beijing: bj, Guangzhou: gz, Shanghai: sh, Hong Kong: hk, North America: ca. Note: Unless otherwise specified in the API document, this parameter is required generally.
No
Timestamp UInt The current UNIX timestamp that records the time at which the API request was initiated. Yes
Nonce UInt A random positive integer that is used in conjunction with Timestamp to prevent replay attacks. Yes
SecretId String 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. Yes
Signature String Request signature, which is used to verify the validity of the request and is automatically generated by the system based on input parameters. For more information, please see Signature Method. Yes

A complete request requires two types of request parameters: common request parameters and API request parameters. Only six common request parameters are listed above. For more information on API request parameters, please see API Request Parameters section.