API Request Parameters

Last updated: 2020-03-04 10:50:09

API request parameters vary by API. API request parameters should always begin with a lowercase letter so that they can be differentiated from common request parameters.
For example, the AddProject API supports the following API request parameters:

Parameter Name Required Type Description
projectName Yes String Project name containing Chinese and English characters as well as digits.
projectDesc No String Project description.

The descriptions of each field are as follows:

Parameter Name Name of the request parameter supported by the API. You can use it as an API request parameter when using the API.
Required Indicates whether this parameter is required. "Yes" means that the parameter is required for the API, while "No" means that it is optional.
Type Data type of this API parameter.
Description A brief description of the API request parameter.

Suppose you want to query a created project, a sample of the request would be as follows:

  https://account.api.qcloud.com/v2/index.php?Action=AddProject
  &Common request parameters
  &projectName=test
  &projectDesc=For testing

A complete TencentCloud API request requires two types of parameters: common request parameters and API request parameters. This document only describes API request parameters. For more information on common request parameters, please see Common Request Parameters.