API Request Parameters

Last updated: 2018-08-13 10:00:12

API request parameters vary with different APIs. The initial letter of each API request parameter is in lowercase so that it can be differentiated from common request parameters.
For example, for the API OnlineDsaHost used to enable a DSA domain name, the supported API request parameters are as follows:

Parameter Require Type Description
hostId Yes Unsigned ID of the domain name connected to DSA

The attributes of the parameter are described as follows:

Parameter Name The request parameter name supported by the API. You can use it as an API request parameter when calling the API.
Note: A parameter name ending with ".n" represents an array, for which you need to input the array members individually.
Required Indicates whether this parameter is required.
"Yes" means the parameter is required when you call the API.
"No" means the parameter can be left empty.
If all the API request parameters are not required, the API can be called simply by using common request parameters.
Type Data type of the API parameter.
Description A brief description of the API request parameter and the API calling.

Example:
If you want to enable a domain name with the hostId (which can be obtained via the API Query List of Domain Names) being 12345, the request link should look like this:

https://dsa.api.qcloud.com/v2/index.php?
&<Common request parameters>
&hostID=12345

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