Configure an HTTP trigger

Updated at:

Function Compute supports HTTP triggers. A function configured with an HTTP trigger can be triggered by HTTP requests. The function processes the requests and returns the results to the caller. This topic describes how to configure an HTTP trigger in the Function Compute console and invoke the function by using HTTP requests.

Prerequisites

Create a function

Step 1: Create a trigger

  1. Log on to the Function Compute console. In the left-side navigation pane, click Functions.

  2. In the top navigation bar, select a region. On the Functions page, click the function that you want to manage.

  3. On the Function Details page, click the Trigger tab and then click Create Trigger.

  4. In the Create Trigger panel, configure the parameters and click OK.

    Configuration Item

    Operation

    Example

    Trigger Type

    Select HTTP Trigger.

    HTTP Trigger

    Name

    Enter a custom name for the trigger.

    http-trigger

    Version or Alias

    Defaults to LATEST. To create a trigger for a different version or alias, select it from the Version or Alias drop-down list on the Function Details page. For more information about versions and aliases, see Version management and Alias management.

    LATEST

    Request Method

    Select the HTTP methods allowed for this trigger.

    GET, POST, PUT, DELETE

    Disable Internet URL

    Disabled by default — the trigger is accessible from its public endpoint.

    When enabled, no public endpoint is provided. Requests to it return access denied due to function internet URL is disable. Custom domain access is unaffected.

    No

    Authentication Method

    Select how Function Compute authenticates HTTP requests:

    No authentication

    After the trigger is created, you can modify its configurations, such as Version or Alias, Request Method, and Authentication Method.

Step 2: Write and deploy code

Write your function code after creating the trigger.

On the Function Details page, click the Code tab. Write code in the code editor and then click Deploy. Refer to the handler documentation for your runtime for sample code.

Step 3: Test the function

Method 1: Use the console to test the function

On the Function Details page, click the Code tab.

  • Synchronous call

    Click Test Function.

  • Asynchronous invocation

    Click the down icon to the right of Test Function, select Async Invocation, and then click Test Function.

After execution completes, view the result on the Code tab.

Method 2: Use cURL to test the function

  1. On the Function Details page, click the Trigger tab. In the Configurations column of the target HTTP trigger, obtain the public endpoint.

  2. Run a cURL command on the command line to test the function.

    Synchronous call

    curl -v https://example.cn-shenzhen.fcapp.run/$path

    Asynchronous invocation

    curl -v -H "X-Fc-Invocation-Type: Async" https://example.cn-shenzhen.fcapp.run/$path

Method 3: (Not recommended) Use a browser to test the function

  1. On the Function Details page, click the Trigger tab. In the Configurations column of the target HTTP trigger, obtain the public endpoint. Enter this endpoint in the address bar of your browser and press Enter.

  2. After execution completes, the browser returns a file that contains the execution result.

(Optional) Use API Gateway to protect the function

Function Compute allows anonymous access to HTTP functions. To prevent unauthorized access, enable identity authentication and connect your HTTP functions to API Gateway. Use API Gateway plug-ins (IP-based access control, JWT, or basic authentication) to protect your functions.

  1. In the Function Compute console, find the target function. On the Function Details page, click the Trigger tab. In the Actions column of the target HTTP trigger, click Modify.

  2. In the Edit Trigger pane, turn on the Disable Internet URL switch.

  3. Log on to the API Gateway console and switch to the region where the HTTP function is located.

  4. Create a group and an API.

    An API allows external applications to invoke the function service in a specified way. An API group organizes and manages related APIs under unified security policies and traffic controls.

    1. In the API Gateway console, choose Manage APIs > API Groups in the left navigation pane. Then, click Create Group.

    2. In the Create Group dialog box, select an Instances:. Set Group Name to FC-Group and BasePath to /. Then, click Confirm.

    3. In the Actions column of the target group, click Manage APIs. Then, click Create API. In the Basic Information section, configure the following parameters and click Next.

      • Group: select FC-Group

      • API Name: enter FC-test

      • Security Authentication: select No Authentication

    4. In the Define API Request section, set Request Path to /, keep the default values for other parameters, and click Next.

    5. In the Define Backend Service section, set Trigger Path to the private endpoint of the Function Compute trigger, which is https://example.cn-hangzhou-vpc.fcapp.run. Keep the default values for other parameters and click Next.

    6. In the Define Response section, keep the default configurations and click Create. After the API is created, click Publish in the Actions column of the API.

  5. Debug the API before publishing. A successful debug confirms the API Gateway-to-Function Compute connection.

    1. In the API Gateway console, choose Call APIs > Debug in the left navigation pane.

    2. On the Debug page, select the FC-test API that you created and click Send Request. If a successful response is returned, the configuration is complete.

  6. Create a Backend Signature plug-in. Set key to your AccessKey ID and secret to your AccessKey secret, then bind it to the API. For more information, see Plug-in overview.

  7. Resolve your domain name to the second-level domain provided by API Gateway using a CNAME record.

    1. In the API Gateway console, choose Manage APIs > API Groups in the left navigation pane. Copy the public second-level domain.

    2. Go to your domain name resolution management page. For Alibaba Cloud, the domain name resolution management page is at https://dns.console.aliyun.com. On the domain name list page, find the domain name you want to manage and click the link on the domain name to go to its management page.

      Note

      Independent domain names in the Chinese mainland must have an ICP filing from Alibaba Cloud or have their ICP filing transferred to Alibaba Cloud.

    3. In the API Gateway console, choose Manage APIs > API Groups in the left navigation pane. Go to the Independent Domains section. At the bottom right of the page, find the button to bind a domain name. Click the button, enter your domain name, and click OK. The domain name is successfully bound.

After completing these steps, access your HTTP function through your custom domain. You can also bind the following plug-ins to further protect it:

Troubleshoot errors

Errors fall into two main categories.

  • Request errors: the request does not meet requirements. Returns a 4xx status code.

  • Function errors: a problem in the function code. Returns a 5xx status code.

The following table lists common error scenarios and their causes.

Error Type

HTTP Status Code

Cause Analysis

Billed

Request error

400

The request exceeds the request limits. For more information, see HTTP trigger overview.

No

400

The request is missing the Date or Authorization header required for authentication.

No

403

The Authorization signature is invalid. The signature is valid for only 15 minutes from the Date header value — a common cause is the Date in the request being more than 15 minutes from the current time.

No

403

The request method is not allowed by the trigger configuration (for example, sending POST when only GET is configured).

No

404

An HTTP request is sent to a function that does not have an HTTP trigger.

No

User throttling

429

Request throttled. Reduce concurrency or contact the Function Compute team to increase your limit.

No

Function error

502

The function response exceeds the response limits. For more information, see HTTP trigger overview.

Yes

502

The function code has a syntax error or an exception.

Yes

502

An HTTP request is sent to a function that does not use an HTTP handler.

Yes

System error

500

Function Compute internal error. Retry the request.

No

System throttling

503

Function Compute system throttling. Retry with exponential backoff.

No

If the issue persists, join the DingTalk group (ID: 64970014484) to contact Function Compute engineers for support.