Help Center/ API Gateway/ Developer Guide (Paris Region)/ Importing and Exporting APIs/ Extended Definition/ x-apigateway-backend/ x-apigateway-backend.functionEndpoints
Updated on 2025-02-21 GMT+08:00
View PDF
Share

x-apigateway-backend.functionEndpoints

Meaning: Function backend service definition.

Scope of effect: x-apigateway-backend

Example:

paths:
  '/users/{userId}':
    get:
      produces:
        - "application/json"
      parameters:
        - name: "X-Auth-Token"
          description: "Authentication token"
          type: "string"
          in: "header"
          required: true
      responses:
        default:
          description: "default response"
      x-apigateway-request-type: "public"
      x-apigateway-backend:
        type: "FUNCTION"
        functionEndpoints:
          version: "v1"
          function-urn: ""
          invocation-type: "synchronous"
          timeout: 30000
Table 1 Parameter description

Parameter

Mandatory

Type

Description

function-urn

Yes

String

Function URN.

version

Yes

String

Function version.

invocation-type

Yes

String

Function invocation type. The value can be async or sync.

timeout

No

Number

Function timeout in milliseconds. The range is 1–60,000, and the default value is 5000.
Parent topic: x-apigateway-backend