component - 腾讯云云函数 - 《Serverless Devs Tool - Serverless 开发工具》

前言
使用

前言

通过本组件，您可以简单快速的将腾讯云函数计算项目部署到线上。

使用

最简使用方法

模版拉取：

s init python3-http -p tencent

其中Yaml的默认配置为：

MyFunction:
  Component: scf
  Provider: tencent
  Access: release
  Properties:
    Region: ap-guangzhou # 函数所在区域
    Namespace:
      Name: default
    Function:
      Name: Test
      Role: exRole # 云函数执行角色
      CodeUri: ./src
      Handler: index.main_handler #入口
      Runtime: Python3.6 # 运行环境
      Description: This is a function in application.
      MemorySize: 128 # 内存大小，单位MB
      Timeout: 20 # 超时时间，单位秒

完整Yaml示例

MyFunction:
  Component: scf
  Provider: tencent
  Access: release
  Properties:
    Region: ap-guangzhou # 函数所在区域
    Namespace:
      Name: default
    Function:
      Name: Name
      Role: exRole # 云函数执行角色
      EnableRoleAuth: true # 默认会尝试创建 SCF_QcsRole 角色，如果不需要配置成 false 即可
      # 1. 默认写法，新建特定命名的 cos bucket 并上传
      CodeUri: ./src
      # 2. CodeUri 为对象，并且制定忽略上传文件夹 node_modules
      # CodeUri:
      #   Src: ./code
      #   Exclude:
      #     - 'node_modules/**'
      # 3. 指定 bucket name 和文件的方式，直接上传 cos 中的文件部署云函数
      # CodeUri:
      #    Bucket: tinatest   # bucket name，当前会默认在bucket name后增加 appid 后缀, e.g. bucketname-appid
      #    Key: 'code.zip'      # bucket key 指定存储桶内的文件
      # 4. 指定本地文件到 bucket
      # CodeUri:
      #   Bucket: tinatest   # bucket name
      #   Src:         # 指定本地路径
      Handler: index.main_handler #入口
      Runtime: Nodejs10.15 # 运行环境 默认 Nodejs10.15
      Description: This is a function in application.
      MemorySize: 128 # 内存大小，单位MB
      Timeout: 20 # 超时时间，单位秒
      Environment: #  环境变量
        - Key: key
          Value: value
      PublicAccess: true # 是否开启公网访问
      Vpc: # 私有网络配置
        VpcId: '' # 私有网络的Id
        SubnetId: '' # 子网ID
      Cfs: # cfs配置
        - CfsId: cfs-123
          MountInsId: cfs-123
          LocalMountDir: /mnt/
          RemoteMountDir: /
      DeadLetter: # 死信队列配置
        Type: deadLetterType
        Name: deadLetterName
        FilterType: deadLetterFilterType
      Layers: #layer配置
        - Name: scfLayer #  layer名称
          Version: 1 #  版本
      Cls: # 函数日志
        LogsetId: ClsLogsetId
        TopicId: ClsTopicId
      Eip: true/false # 是否开启固定IP
      Tags: #标签配置
        - Key: key
          Value: value
      Triggers: # 触发器
        -   Type: timer # 定时触发器
            Name: #触发器名称，默认timer-${name}-${stage}
            Parameters:
              CronExpression: '*/5 * * * *' # 每5秒触发一次
              Enable: true
              Argument: argument # 额外的参数
        -   Type: apigw # api网关触发器，已有apigw服务，配置触发器
            Name: #触发器名称，默认apigw-${name}-${stage}
            Parameters:
              Service:
                  Name: serverless
                  Id: service-8dsikiq6
                  Protocols:
                    - http
                  NetTypes:
                    - OUTER
                  Description: the serverless service
                  Environment: release
              API:
                - Path: /users
                  Method: POST
                - Path: /test/{abc}/{cde}
                  Id: api-id
                  Method: GET
                  Description: Serverless REST API
                  EnableCORS: TRUE
                  ResponseType: HTML
                  ServiceTimeout: 10
                  Parameters:
                    - Name: abc
                      Position: PATH
                      Required: 'TRUE'
                      Type: string
                      DefaultValue: abc
                      Description: mytest
                    - Name: cde
                      Position: PATH
                      Required: 'TRUE'
                      Type: string
                      DefaultValue: abc
                      Description: mytest
                  Function:
                    IsIntegratedResponse: TRUE
                    FunctionQualifier: $DEFAUlt
                  UsagePlan:
                    UsagePlanId: 1111
                    UsagePlanName: slscmp
                    UsagePlanDesc: sls create
                    MaxRequestNum: 1000
                  Auth:
                    ServiceTimeout: 15
                    SecretName: secret
                    SecretIds:
                      - xxx
        -   Type: apigw # api网关触发器，无apigw服务，自动创建服务
            Name:  #触发器名称，默认apigw-${name}-${stage}
            Parameters:
              Service: 
                  Name: apigw-xxxx
                  Protocols:
                    - http
                  Description: the serverless service
                  Environment: release
              API:
                - path: /users
                  method: POST
        -   Type: cos # cos触发器
            Name:  #触发器名称，默认cos-${name}-${stage}
            Parameters:
              Bucket: cli-appid.cos.ap-beijing.myqcloud.com
              Filter:
                Prefix: filterdir/
                Suffix: .jpg
              Events: 'cos:ObjectCreated:*'
              Enable: true
        -   Type: cmq # CMQ Topic 触发器
            Name:  #触发器名称，默认cmq-${name}-${stage}
            Parameters:
              Name: test-topic-queue
              Enable: true
              FilterType: 1 # 消息过滤类型，1为标签类型，2为路由匹配类型
              FilterKey: # 当 filterType 为1时表示消息过滤标签，当 filterType 为2时表示 Binding Key
                - key1
                - key2
        -   Type: ckafka # ckafka触发器
            Name:   #触发器名称，默认ckafka-${name}-${stage}
            Parameters:
              Name: ckafka-2o10hua5
              Topic: test
              MaxMsgNum: 999
              Offset: latest
              Enable: true

详细使用方法

| 参数名 | 必填 | 类型 | 参数描述 | | —- | —- | —- | —- |

Namespace

| 参数名 | 必填 | 类型 | 参数描述 | | —- | —- | —- | —- |

Function

| 参数名称 | 是否必选 | 类型 | 默认值 | 描述 | | —- | —- | —- | —- | —- |

| Name | true | String | ${name}-${stage}-${app} | 创建的函数名称。函数名称支持 26 个英文字母大小写、数字、连接符和下划线，第一个字符只能以字母开头，最后一个字符不能为连接符或者下划线，名称长度 2-60。云函数名称又是资源 ID，为了保证资源的唯一性，默认采用 ${name}-${stage}-${app} 变量方式。 |

| Handler | false | String | Pyton/Php/Nodejs 默认值为 index.main_handler，Java 默认值为 example.Hello::mainHandler，Go 默认值为 main | 函数处理方法名称，名称格式支持 “文件名称.方法名称” 形式，文件名称和函数名称之间以”.”隔开，文件名称和函数名称要求以字母开始和结尾，中间允许插入字母、数字、下划线和连接符，文件名称和函数名字的长度要求是 2-60 个字符。 |

| Description | false | String | This is a function in ${app} application | 函数描述,最大支持 1000 个英文字母、数字、空格、逗号、换行符和英文句号，支持中文 |

CodeUri

| 参数名称 | 是否必选 | 类型 | 默认值 | 描述 | | —- | —- | —- | —- | —- |

Environment

| 参数名 | 必填 | 类型 | 参数描述 | | —- | —- | —- | —- |

Vpc

| 参数名称 | 是否必选 | 类型 | 描述 | | —- | —- | —- | —- |

Layers

| 参数名称 | 是否必选 | 类型 | 描述 | | —- | —- | —- | —- |

DeadLetter

| 名称 | 是否必选 | 类型 | 描述 | | —- | —- | —- | —- |

Cls

| 参数名称 | 是否必选 | 类型 | 描述 | | —- | —- | —- | —- |

Cfs

| 参数名称 | 是否必选 | 类型 | 描述 | | —- | —- | —- | —- |

Triggers

| 参数名称 | 是否必选 | 类型 | 描述 | | —- | —- | —- | —- |

参考： https://cloud.tencent.com/document/product/583/39901
触发器配置为数组，按照配置的 name 和 param 创建触发器。对于 apigw 触发器，如果没有配置 apigw 服务 ID，则自动创建一个 apigw 服务，对于其他触发器仅执行配置触发器，不涉及服务资源创建。
支持以下触发器：timer（定时触发器）、apigw（网关触发器）、cos（COS 触发器）、cmq（CMQ Topic 触发器）、ckafka（CKafka 触发器）。

timer 触发器参数

参考： https://cloud.tencent.com/document/product/583/9708

| 参数名称 | 是否必选 | 类型 | 默认值 | 描述 | | —- | —- | —- | —- | —- |

cos 触发器参数

参考： https://cloud.tencent.com/document/product/583/9707

| 参数名称 | 是否必选 | 类型 | 默认值 | 描述 | | —- | —- | —- | —- | —- |

其中Filter：

| 参数名 | 必填 | 类型 | 参数描述 | | —- | —- | —- | —- |

cmq 触发器参数

| 参数名称 | 是否必选 | 类型 | 默认值 | 描述 | | —- | —- | —- | —- | —- |

ckafka 触发器参数

| 参数名称 | 是否必选 | 类型 | 默认值 | 描述 | | —- | —- | —- | —- | —- |

apigw 触发器参数

| 参数名 | 必填 | 类型 | 参数描述 | | —- | —- | —- | —- |

其中Service：

| 参数 | 必填 | 参数类型 | 默认值 | 描述 | | —- | —- | —- | —- | —- |

Domains：

| 参数 | 必填/可选 | 参数类型 | 默认值 | 描述 | | —- | —- | —- | —- | —- |

PathMappingSet：

| 参数名 | 必填 | 类型 | 参数描述 | | —- | —- | —- | —- |

其中API：

| 参数 | 必填/可选 | 类型 | 默认值 | 描述 | | —- | —- | —- | —- | —- |

ServiceConfig

| 参数 | 描述 | | —- | —- |

| Url | API 的后端服务 url |

| Path | API 的后端服务路径 |

| Method | API 的后端服务请求方法 |

UsagePlan

| 参数 | 描述 | | —- | —- |

| UsagePlanId | 用户自定义的基于 API 的使用计划 ID |

| UsagePlanName | 用户自定义的基于 API 的使用计划名称 |

| UsagePlanDesc | 用户自定义的基于 API 的使用计划描述 |

| MaxRequestNum | 允许的请求总数。不传该参数时默认为 1000 次，若其保留为空，则默认情况下将使用-1，表示已禁用 |

Auth

| 参数 | 描述 | | —- | —- |

| SecretName | 用户自定义的密钥名称 |

| SecretIds | 用户自定义的 secretID。当类型为手动时需要。它可以包含 5 到 50 个字母，数字和下划线。 |

Parameters

| 参数 | 描述 | | —- | —- |

| Name | 请求参数名称 |

| Position | 参数位置，仅支持PATH，QUERY和HEADER类型 |

| Type | 参数类型，如 String 和 int. |

| DefaultValue | 参数默认值 |

| Required | 参数是否必填， true: 必填; false: 可选 |

腾讯云 云函数

前言

使用

最简使用方法

完整Yaml示例

详细使用方法

Namespace

Function

CodeUri

Environment

Vpc

Layers

DeadLetter

Cls

Tags

Cfs

Triggers

timer 触发器参数

cos 触发器参数

cmq 触发器参数

ckafka 触发器参数

apigw 触发器参数

ServiceConfig

UsagePlan

Auth

Parameters

腾讯云云函数