API Request Parameters

Last updated: 2017-03-21 16:57:24

PDF

API request parameters are specific to each API. This means that different APIs support different API request parameters. The first letter of each API request parameter is lowercase so that the parameter can be differentiated from common request parameters.

Take Query Domain Information by Domain (GetHostInfoByHost) as an example. This API supports the following API request parameters:

Parameter Name Required Type Description
hosts.n Yes String Domain to be queried

The description of each field is as follows:

Parameter Name The name of request parameter supported by the API, which the user can use as an API request parameter when using this API.
Note: When a parameter name ends with ".n", it means the parameter is an array, and you need to pass the array parameters in sequence when using it. For example, when using "Query Domain Information by Domain" API (GetHostInfoByHost), if you pass the parameter hosts.0=www.abc.com&hosts.1=www.def.com, you will be querying information about two domains whose hosts are www.abc.com and www.def.com, respectively.
Required Indicate whether this parameter is required. If it is "Yes", it means that the parameter is mandatory for the API; If it is "No", the parameter is not mandatory. If all the API request parameters are not mandatory, the API call can be achieved simply by using common request parameters.
Type The data type of the API parameter.
Description A brief description of the API request parameter.

Assuming that a user wants to query the details of www.abc.com and www.def.com, the request link may be as follows:

https://cdn.api.qcloud.com/v2/index.php?
&<Common request parameters>
&hosts.0=www.abc.com
&hosts.1=www.def.com

A complete request needs two types of request parameters: common request parameters and API request parameters. Only API request parameters are listed above. For information on common request parameters, refer to Common Request Parameters section.