Alicloud Function Compute API

Resources

#

• https://www.npmjs.com/package/@alicloud/fc-open20210406/v/2.0.9

CreateService

#

重要参数

#

vpcConfig 字典包含以下键值：

logConfig 字典包含以下键值：

nasConfig 字典包含以下键值：

GetService

#

重要参数

#

CreateFunction

#

重要参数

#

runtime参数

#

runtime参数用于指定函数的运行环境。它决定了函数在何种语言和框架下执行。以下是runtime参数的常见取值及其对应的运行环境：

对于大多数常用的编程语言和框架，可以直接选择相应的runtime取值。

对于自定义运行时环境，可以选择"custom"作为runtime的取值，并提供自定义的运行时环境。自定义运行时环境需要提供相应的配置和执行文件，以便在函数中正确运行。

code参数

#

code参数用于指定函数的代码内容或代码存储位置。根据函数的具体需求和使用情况，code参数可以采用不同的设置方式。以下是对code参数的详细介绍：

• 代码内容：可以直接将函数的代码内容作为字符串传递给code参数。这适用于函数代码比较简单且较短小的情况。将代码内容作为字符串传递给code参数时，通常需要指定runtime参数来指定函数的运行环境。

• 代码存储位置：可以将函数的代码存储在指定的位置，例如对象存储（如OSS）或代码仓库（如GitHub），然后通过code参数提供相关的配置信息来引用这些存储位置的代码。具体的设置方式会根据不同的云服务提供商和平台而有所不同，通常需要提供存储位置的信息（如存储桶名称、对象键或代码仓库地址等）。

对于直接传递代码内容的方式，阿里云提供了使用Base64编码的zip包方式。您可以将函数代码打包成zip包，并使用Base64编码将其转换为字符串，然后将该字符串作为zipFile字段的值传递给code参数。

对于代码存储位置的情况，您需要提供相应的配置信息，例如存储位置的访问密钥、存储桶名称、对象键等。具体的设置方式会因云服务提供商和平台而有所不同。例如，在使用对象存储（如OSS）存储位置的情况下，可以提供如下配置：

code = {
  "ossBucketName": "my-bucket",
  "ossObjectName": "my-function.zip",
  "ossAccessKeyId": "my-access-key-id",
  "ossAccessKeySecret": "my-access-key-secret"
}

CreateFunction(serviceName="my-service", functionName="my-function", code=code, ...)

customContainerConfig参数

#

GetFunction

#

重要参数

#

以下是GetFunction接口的参数列表，包括参数名、参数类型、是否必填和参数描述：

CreateTrigger

#

重要参数

#

CreateTrigger函数是用于创建触发器的阿里云函数计算接口。通过该接口，您可以为函数关联不同类型的触发器，例如定时触发器、API网关触发器、对象存储（OSS）触发器等。

以下是CreateTrigger函数的使用方式：

1. 首先，确保已经创建了需要触发的函数（使用CreateFunction函数创建）。

2. 构造CreateTrigger函数的请求参数，包括以下必填字段：

   • serviceName：函数所属的服务名称。
   • functionName：要创建触发器的函数名称。
   • triggerName：触发器的名称，用于在函数中唯一标识触发器。
   • triggerType：触发器的类型，例如Timer（定时触发器）、OSS（对象存储触发器）、HTTP（HTTP触发器）等。
   • triggerConfig：触发器的配置信息，根据不同类型的触发器有所不同。

3. 根据需要，可以设置CreateTrigger函数的其他可选参数，例如qualifier（函数版本或别名）等。

4. 调用CreateTrigger函数，传递请求参数，并获取返回结果。返回结果将包含触发器的相关信息，如触发器ID、触发器状态等。

阿里云触发器类型

#

CreateTrigger函数支持多种触发器类型，您可以根据具体的需求选择适合的触发器类型。以下是一些常见的触发器类型及其简要介绍：

1. 定时触发器（Timer）：根据预设的时间表达式，周期性地触发函数的执行，例如每小时、每天、每周等。可以设置函数在特定时间点或时间间隔内触发。

2. 对象存储触发器（OSS）：当阿里云对象存储（OSS）上的文件发生变化时触发函数执行，例如文件上传、删除等事件。

3. API网关触发器（HTTP）：将函数作为后端服务与阿里云API网关结合，实现基于HTTP请求的触发，例如接收API请求并进行处理。

4. 日志服务触发器（Log）：当日志服务中有新的日志产生时触发函数执行，例如实时处理日志、触发告警等。

5. Table Store触发器（TableStore）：当阿里云Table Store中的数据发生变化时触发函数执行，例如数据更新、插入等操作。

参考网址： 阿里云触发器简介

Timer触发器

#

以下是一个定时触发器配置信息的例子，包括时间表达式和其他可选参数：

{
  "serviceName": "my-service",
  "functionName": "my-function",
  "triggerName": "my-timer-trigger",
  "triggerType": "Timer",
  "triggerConfig": {
    "cronExpression": "0 0 9 * * ?",  // 每天上午9点触发
    "enable": true,
    "payload": "{\"key\": \"value\"}"
  },
  "qualifier": "LATEST"
}

在上述例子中，配置信息的各个字段的含义如下：

• serviceName：函数所属的服务名称。
• functionName：要关联定时触发器的函数名称。
• triggerName：定时触发器的名称。
• triggerType：指定为"Timer"，表示创建定时触发器。
• triggerConfig：包含触发器的具体配置信息。
  • cronExpression：时间表达式，指定触发器的触发时间。在此例中，表示每天的上午9点触发。
  • enable：是否启用触发器。
  • payload：可选的触发器参数，作为函数调用时传递的输入参数。在此例中，使用JSON字符串作为示例。
• qualifier：可选参数，指定函数版本或别名。在此例中，设置为"LATEST"，表示使用最新版本的函数。

HTTP触发器

#

以下是一个HTTP触发器的配置信息示例：

{
  "serviceName": "my-service",
  "functionName": "my-function",
  "triggerName": "my-http-trigger",
  "triggerType": "HTTP",
  "triggerConfig": {
    "authType": "ANONYMOUS",
    "methods": ["GET", "POST"],
    "url": "/my-endpoint"
  },
  "qualifier": "LATEST"
}

在上述例子中，配置信息的各个字段的含义如下：

• serviceName：函数所属的服务名称。
• functionName：要关联HTTP触发器的函数名称。
• triggerName：HTTP触发器的名称。
• triggerType：指定为"HTTP"，表示创建HTTP触发器。
• triggerConfig：包含触发器的具体配置信息。
  • authType：HTTP触发器的认证类型，可以选择"ANONYMOUS"（匿名访问）或"CUSTOM"（自定义认证）。
  • methods：允许的HTTP请求方法列表。在此例中，允许GET和POST请求。
  • url：定义触发器的URL路径。在此例中，设置为"/my-endpoint"。
• qualifier：可选参数，指定函数版本或别名。在此例中，设置为"LATEST"，表示使用最新版本的函数。

GetTrigger

#

重要参数

#

以下是GetTrigger接口的参数列表，包括参数名、参数类型、是否必填和参数描述：

InvokeFunction

#

重要参数

#

以下是InvokeFunction接口的参数列表，包括参数名、参数类型、是否必填和参数描述：