Updated on 2023-12-13 GMT+08:00

APIG.BackendApi

Property Description

Table 1 Property description

Property

Required

Type

Description

remark

No

string

Description of the backend API

Value Description: Supports a maximum of 255 characters.

Value Constraint: Supports a maximum of 255 characters.

Suggestion: None

urlDomain

Yes

string

Access domain name

Value Description: Consists of the backend service address and port, and supports a maximum of 255 characters.

Value Constraint: Supports a maximum of 255 characters.

Suggestion: None

reqUri

Yes

string

Request address of the backend API

Value Description: Supports a maximum of 512 characters and meets the URI specifications.

Value Constraint: The value range from 3 to 512.

Suggestion: None

timeout

No

integer

Timeout interval for the API gateway to request backend services

Value Description: Supports the maximum value of 60000 and the minimum value of 1 (unit: ms).

Value Constraint: The value range from 1 to 60000.

Suggestion: None

reqMethod

Yes

string

Request mode of the backend API

Value Description: Supports the following methods: GET, POST, PATCH, DELETE, OPTIONS, PUT, HEAD, and ANY.

Value Constraint: Supports GET, POST, DELETE, PUT, PATCH, HEAD, OPTIONS, ANY

Suggestion: None

reqProtocol

Yes

string

Protocol type of the backend API

Value Description: Supports HTTP and HTTPS.

Value Constraint: Supports HTTP, HTTPS

Suggestion: If sensitive information needs to be transferred, you are advised to use HTTPS.