All Products
Search
Document Center

API Gateway:RequestConfig

Last Updated:Nov 12, 2024

The frontend information.

Node

RequestConfig

Subnode

Parameter

Type

Required

Description

Example

RequestProtocol

String

Yes

The protocol type supported by the API. Valid values: HTTP and HTTPS. Separate multiple values with commas (,), such as "HTTP,HTTPS".

HTTP

RequestHttpMethod

String

Yes

The HTTP request method. Valid values: GET, POST, DELETE, PUT, HEADER, TRACE, PATCH, CONNECT, and OPTIONS.

GET

RequestPath

String

Yes

API path

/a

RequestMode

String

Yes

The request mode. Valid values: MAPPING, MAPPING_PASSTHROUGH, and PASSTHROUGH. A value of MAPPING specifies that input parameters are mapped and unknown parameters are filtered out. A value of MAPPING_PASSTHROUGH specifies that input parameters are mapped and unknown parameters are passed through. A value of PASSTHROUGH specifies that input parameters are passed through, regardless of whether the parameters are known or unknown.

MAPPING

BodyFormat

String

No

The form in which data is passed to the server if the HTTP method of the request is POST or PUT. Valid values: FORM and STREAM. A value of FORM specifies that data is passed as key-value pairs in forms, and a value of STREAM specifies that data is passed as byte streams. This parameter takes effect when the RequestMode parameter is set to MAPPING.

FORM

PostBodyDescription

String

No

The description of the request body.

test