In Function Compute, you can use a function to call the ApsaraDB RDS for PostgreSQL API to perform operations such as insert and query on an ApsaraDB RDS for PostgreSQL database. In normal cases, states cannot be shared among different execution environments in Function Compute. You can persist structured data in a database so that states can be shared. This topic describes how to use Funcraft to deploy a function to access an ApsaraDB RDS for PostgreSQL database.


  1. You have created a virtual private cloud (VPC) and a VSwitch.

    The VSwitch must belong to a zone supported by Function Compute. For more information about the zones supported by Function Compute, see VPC access.

  2. Create an ApsaraDB RDS for PostgreSQL instance

    You have created a database instance in same VPC as Function Compute. You do not need to create the VSwitch in the same zone as Function Compute. VSwitches under the same VPC can communicate with each other even when they are in different zones.

  3. Configure an IP address whitelist for an ApsaraDB RDS for PostgreSQL instance

    If you need to control access to databases by using an IP address whitelist, ensure that you have entered the internal Classless Inter-Domain Routing (CIDR) blocks of the target VPCs in the IP field. To find the CIDR block of a VPC, log on to the VPC console and view the VPC Details page.

  4. Create a security group

    You have configured the security group to allow outbound traffic from the internal CIDR block and port of the database.

Write code for a function

The following section describes how to use Funcraft to write a function that accesses a database. The sample code is written in Python 3.

  1. On the local machine, create a directory to store code and dependent modules. In the directory, create the template.yml file. In this example, the /tmp/code/template.yml file is created and contains the following content:
    ROSTemplateFormatVersion: '2015-09-01'
    Transform: 'Aliyun::Serverless-2018-04-03'
        Type: 'Aliyun::Serverless::Service'
          Description: This is PostgreSQL service
            - AliyunECSNetworkInterfaceManagementAccess      
            VpcId: vpc-****
              - vsw-***
            SecurityGroupId: sg-***
          InternetAccess: true
          Type: 'Aliyun::Serverless::Function'
            Handler: 'index.handler'
            Initializer: 'index.initializer'
            Runtime: python3
            Timeout: 10
            MemorySize: 128
            CodeUri: '. /'
              HOST: pgm-bp1yawvyyu***
              PASSWORD: Txd123**
              PORT: 1433
              DATABASE: test_123
              USER: ***

    The following list describes the main parameters:

    • A service named service is declared.
      • Policies: grants Function Compute permission to manage elastic network interfaces (ENIs) attached to Elastic Compute Service (ECS) instances. Function Compute can then access resources in the VPC.
      • VpcConfig: binds the VPC to the service. You must replace the following values with the information for your VPC.
        • VpcId: the ID of the VPC.
        • VSwitchId: the ID of the VSwitch.
        • SecurityGroupId: the ID of the security group.
    • A function named function is declared.
      • Initializer: the initializer function. For more information, see Initializer function.
      • Handler: the function handler. For more information, see Function entry point.
      • Runtime: the runtime environment of the function.
      • CodeUri: the directory where the code package is located.

        During function deployment, Funcraft packages and uploads the items in the directory specified by the CodeUri parameter.

      • EnvironmentVariables: the environment variables of the function.
        • HOST: the internal endpoint of the ApsaraDB RDS for PostgreSQL instance.

          Log on to the ApsaraDB RDS console. Click the instance that you require to go to the Basic Information page. In the Basic Information section, click See Detail to view the internal endpoint.

        • PASSWORD: the password used to log on to the database.
        • PORT: the port of the database.
        • DATABASE: the name of the database.
        • USER: the username used to log on to the database.
  2. In the directory that contains the template.yml file, create the Funfile file. In this example, the new file contains the following sample content:
    RUNTIME python3
    RUN fun-install pip install psycopg2
  3. Run the fun install command to install dependencies.
    fun install
    When the code editor shows the following content, the dependencies have been installed.
    Install Success
  4. In the directory that contains the template.yml file, create a Python file. In this example, the /tmp/code/ file is created and contains the following sample content:
    # -*- coding: utf-8 -*-
    import logging
    import psycopg2
    import os,sys
    logger = logging.getLogger()
    def getConnection():
        conn = psycopg2.connect(
          database = os.environ['DATABASE'],
          user = os.environ['USER'],
          password = os.environ['PASSWORD'],
          host = os.environ['HOST'],
          port = os.environ['PORT'],
        return conn
      except Exception as e:
        logger.error("ERROR: Unexpected error: Could not connect to PostgreSQL instance.")
    def conditionallyCreateUsersTable():
        conn = getConnection()
        cur = conn.cursor()
        cur.execute('''CREATE TABLE COMPANY
            (ID INT PRIMARY KEY     NOT NULL,
            NAME           TEXT    NOT NULL,
            AGE            INT     NOT NULL,
            ADDRESS        CHAR(50),
            SALARY         REAL);''')
    def initializer(context):
    def handler(event, context):
        conn = getConnection()
        cur = conn.cursor()
          VALUES (1, 'Paul', 32, 'California', 20000.00 )");
        return 'successfully'
  5. Run the following command to deploy the function to Function Compute by using Funcraft:
    fun deploy -y
    When the code editor shows the following content, the function has been deployed.
            function <function-name> deploy success
    service <service-name> deploy success

    After the deployment is complete, log on to the and click Service/Function. On the page that appears, you can see the newly deployed service and function.

Debug the function

After the function is deployed, you can debug it in the Function Compute console.

  1. Log on to the Function Compute console.
  2. In the top navigation bar, select a region.
  3. In the left-side navigation pane, click Services and Functions.
  4. In the Services pane, click the service that you require. On the Functions tab, click the name of the function that you require.
  5. On the page that appears, click the Code tab. On the Code tab, click Invoke.
    After the execution is complete, you can view the execution results and logs.postgre-log