All Products
Search

This Product

    API Gateway:HttpApiParameter

    Document Center

    API Gateway:HttpApiParameter

    Last Updated:Aug 28, 2026

    Parameter

    Type

    Description

    Example

    object

    The parameter definition.

    name

    string

    The parameter name.

    userId
    required

    boolean

    Specifies whether the parameter is required.

    true
    type

    string

    The parameter type.

    Valid values:

    • Integer

    • Number

    • String

    • Boolean

    String
    defaultValue

    string

    The default value of the parameter.

    123
    exampleValue

    string

    The sample value of the parameter.

    123
    description

    string

    The parameter description.

    用户ID