In Function Compute, you can use a function to call database APIs to insert or query data. In most cases, instance status is not shared among different execution environments in Function Compute. If you want to share instance status, you need to store structured data in a database. This topic describes how to deploy a function to access an ApsaraDB RDS for SQL Server database by using Serverless Devs. Python 3 is used in this topic.


  • Create an ApsaraDB RDS for SQL Server instance
    • Make sure that the database instance that you create is in the same region as the function that needs to access the database instance.

    • We recommend that you create the database instance in a zone that Function Compute supports.

      If your resources are not deployed in the zones shown in the following list, create a vSwitch in your virtual private cloud (VPC). The vSwitch must be in the same zone as Function Compute. Also, you must specify the vSwitch ID when you configure the VPC for Function Compute. vSwitches in the same VPC can communicate with each other over the private network. Therefore, Function Compute can use the vSwitch to access resources in VPCs that reside in other zones. For more information, see How can I resolve the "vSwitch is in unsupported zone" error?.

      Region Region ID Zone
      China (Hangzhou) cn-hangzhou cn-hangzhou-f, cn-hangzhou-g, cn-hangzhou-h
      China (Shanghai) cn-shanghai cn-shanghai-b, cn-shanghai-e, cn-shanghai-g, cn-shanghai-f
      China (Qingdao) cn-qingdao cn-qingdao-c
      China (Beijing) cn-beijing cn-beijing-h, cn-beijing-c, cn-beijing-e, cn-beijing-f
      China (Zhangjiakou) cn-zhangjiakou cn-zhangjiakou-b, cn-zhangjiakou-a
      China (Hohhot) cn-huhehaote cn-huhehaote-a, cn-huhehaote-b
      China (Shenzhen) cn-shenzhen cn-shenzhen-e, cn-shenzhen-d
      China (Chengdu) cn-chengdu cn-chengdu-a, cn-chengdu-b
      China (Hong Kong) cn-hongkong cn-hongkong-c
      Singapore (Singapore) ap-southeast-1 ap-southeast-1a, ap-southeast-1b
      Australia (Sydney) ap-southeast-2 ap-southeast-2a, ap-southeast-2b
      Malaysia (Kuala Lumpur) ap-southeast-3 ap-southeast-3a
      Indonesia (Jakarta) ap-southeast-5 ap-southeast-5a, ap-southeast-5b
      Japan (Tokyo) ap-northeast-1 ap-northeast-1b, ap-northeast-1a
      UK (London) eu-west-1 eu-west-1a
      Germany (Frankfurt) eu-central-1 u-central-a, eu-central-1a, eu-central-1b
      US (Silicon Valley) us-west-1 us-west-1a, us-west-1b
      US (Virginia) us-east-1 us-east-1b, us-east-1a
      India (Mumbai) ap-south-1 ap-south-1a, ap-south-1b
  • Create a table named users.

    In this example, you can use the s init command to query all data in the users table in the database. You must create the users table in advance.

  • Install Serverless Devs and Docker
  • Configure Serverless Devs
  • Create a security group

    Create a default security group in the VPC where the database instance is deployed. If you want to use an existing security group, make sure that the security group allows outbound traffic to the ports and private CIDR blocks of the database instance. By default, the security group allows all outbound traffic.

Configure an IP address whitelist for a database

We recommend that you use an IP address whitelist, instead of security groups, for secure access. Otherwise, the function connection may be unstable, which affects your business.

  1. Log on to the ApsaraDB RDS console.
  2. In the left-side navigation pane, click Instances.
  3. In the top navigation bar, select a region.
  4. On the Instances page, find the desired instance and click the instance ID.
  5. In the left-side navigation pane, click Data Security.
  6. On the Whitelist Settings tab that appears, find the default whitelist group and click Modify.
  7. In the Edit Whitelist dialog box, configure IP Addresses and click OK.
    Notice You must specify an IP address that belongs to the CIDR block of the vSwitch that you add when you configure the network for Function Compute.

Deploy and invoke a function

  1. Initialize a project.
    s init start-fc-sql-server-python -d start-fc-sql-server-python
  2. Access the project.
    cd start-fc-postgresql-python
  3. Edit the s.yaml file.


    edition: 1.0.0          
    name: fcDeployApp       
    access: "default"  
        component: devsapp/fc  
          region: cn-hangzhou
            name: fc-db-demo
            description: 'demo for fc visit db'
            internetAccess: true
              vpcId: vpc-bp1hcg467ekqsv0zr**** # The ID of the virtual private cloud (VPC) in which the database instance resides. 
              securityGroupId: sg-bp1j6knvj40yjn0g**** # The ID of the security group. 
                - vsw-bp1lgecrqfslgji9b**** # Make sure that the CIDR block of the vSwitch is added to the whitelist of the database instance. 
            name: sql_server
            description: visit sql server
            runtime: python3
            codeUri: ./code
            handler: index.handler
            memorySize: 256
            timeout: 60
              MSSQL_SERVER: rm-bp1lbgwj1pw87**** # The endpoint of the database. 
              MSSQL_PORT: 14** # The port of the database. 
              MSSQL_USER: sqlse**** # The username of the database. 
              MSSQL_PASSWORD: Hang**** # The password of the database. 
              MSSQL_DATABASE: ni**** # The name of the database. 
  4. Run the following command to build the project:
    s build --use-docker
  5. Run the following command to deploy the project:
    s deploy -y
  6. Run the following command to invoke a function:
    s invoke -e "{}"

    Expected command output:

    [2021-09-22T22:43:24.266] [INFO ] [S-CLI] - Start ...
    ========= FC invoke Logs begin =========
    FC Invoke Start RequestId: 2768263f-1fb4-4146-be78-a00a6d8e656e
    2021-09-22T14:43:24.816Z 2768263f-1fb4-4146-be78-a00a6d8e656e [INFO] None
    FC Invoke End RequestId: 2768263f-1fb4-4146-be78-a00a6d8e656e
    Duration: 46.54 ms, Billed Duration: 47 ms, Memory Size: 256 MB, Max Memory Used: 38.30 MB
    ========= FC invoke Logs end =========
    FC Invoke Result:
    End of method: invoke