All Products
Search
Document Center

API Gateway:HttpApiParameter

Last Updated:Jan 22, 2026
ParameterTypeDescriptionExample
object

The parameter definition.

namestring

The parameter name.

userId
requiredboolean

Specifies whether the parameter is required.

true
typestring

The parameter type.

Valid values:

  • Integer
  • Number
  • String
  • Boolean
String
defaultValuestring

The default value of the parameter.

123
exampleValuestring

The sample value of the parameter.

123
descriptionstring

The parameter description.

The example description.