API Request Parameters

Last updated: 2017-07-25 11:15:11

API request parameters are specific to each API. Different APIs support different API request parameters. The first letter of each API request parameter is in lowercase so that the parameters can be differentiated from common request parameters.
Take API Create Namespace (CreateNamespace) as an example. It supports the following API request parameters:

Parameter Name Required Type Description
namespace Yes String Namespace: It contains 32 characters, including letters, numbers and underscores

The above field is described below:

Parameter Name Name of request parameter supported by the API. The user can use this name as an API request parameter when using this API.
Required Indicate whether this parameter is required. "Yes" means the parameter is required when you call the API. "No" means the parameter is not required. All the API request parameters are required in the API "Create Namespace" (CreateNamespace).
Type Data type of the API parameter.
Description A brief description of the API request parameter.

If a user wants to create a namespace, the request link may be as follows:

 &<Common request parameters>

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.

Was this page helpful?

Was this page helpful?

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