API概览

更新时间:
复制为 MD 格式

本产品(FC/2023-03-30)的OpenAPI采用ROA签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

资源组

API

标题

API概述

ChangeResourceGroup 更新资源组 更新函数计算资源的资源组。

地域

API

标题

API概述

DescribeRegions 查询FC 3.0产品地域信息 查询FC 3.0产品支持的地域信息。

自定义域名

API

标题

API概述

CreateCustomDomain 创建自定义域名 创建自定义域名。
DeleteCustomDomain 删除自定义域名 删除自定义域名。
GetCustomDomain 获取自定义域名 获取自定义域名配置。
ListCustomDomains 列出自定义域名 获取自定义域名信息列表。
UpdateCustomDomain 更新自定义域名 更新自定义域名。

函数

API

标题

API概述

DeleteFunctionVersion 删除函数版本 删除函数版本。
GetFunctionCode 获取函数代码 获取函数代码包的详情。
ListFunctionVersions 列出函数版本 查询指定函数的版本列表。
PublishFunctionVersion 发布函数版本 发布函数版本。
CreateFunction 创建函数 调用CreateFunction接口创建函数。
DeleteFunction 删除函数 删除函数。
GetFunction 获取函数 获取函数信息。
ListFunctions 列出函数 获取函数列表。
InvokeFunction 调用函数 调用执行函数。
UpdateFunction 更新函数 更新函数信息。
EnableFunctionInvocation 允许函数调用 允许函数被调用,并恢复预留实例的创建。该 OpenAPI 处于内测阶段。
DisableFunctionInvocation 禁止函数调用 禁止函数被调用,可选终止所有正在处理的请求。函数被禁止调用后,将无法创建新实例,同时预留实例会被销毁。该 OpenAPI 处于内测阶段。

别名

API

标题

API概述

DeleteAlias 删除别名 删除别名。
GetAlias 获取别名 获取别名信息。
ListAliases 列出别名 查询别名列表信息。
UpdateAlias 更新别名 更新别名。
CreateAlias 创建别名 创建别名。

触发器

API

标题

API概述

CreateTrigger 创建触发器 创建触发器。
DeleteTrigger 删除触发器 删除指定的触发器。
GetTrigger 获取触发器 获取指定的触发器详情。
ListTriggers 列出触发器 查询指定函数的触发器列表。
UpdateTrigger 更新触发器 更新触发器信息。

函数异步配置

API

标题

API概述

DeleteAsyncInvokeConfig 删除异步配置 删除异步调用配置。
GetAsyncInvokeConfig 获取异步配置 获取指定函数的异步调用配置。
ListAsyncInvokeConfigs 列出函数异步配置 查询指定函数的所有异步配置信息。
PutAsyncInvokeConfig 设置函数异步配置 创建或更新函数的异步调用配置。

预留函数配置

API

标题

API概述

DeleteProvisionConfig 删除预留配置 删除预留配置。
GetProvisionConfig 获取预留配置 获取预留配置。
ListProvisionConfigs 列出函数预留配置 查询预留配置列表。
PutProvisionConfig 设置函数预留实例 创建预留配置。

函数并发配置

API

标题

API概述

DeleteConcurrencyConfig 删除并发度配置 删除并发度配置。
GetConcurrencyConfig 获取并发度配置 获取并发度配置。
ListConcurrencyConfigs 列出函数并发度配置 查询并发度配置列表。
PutConcurrencyConfig 设置函数并发度 设置函数并发度。

API

标题

API概述

CreateLayerVersion 创建层版本 发布层版本。
DeleteLayerVersion 删除层版本 删除层版本。
GetLayerVersion 获取层版本 获取层的版本信息。
GetLayerVersionByArn 通过ARN获取层版本 通过ARN获取层的版本信息。
ListLayerVersions 列出层版本 获取层的版本列表。
ListLayers 列出层 获取层列表。
PutLayerACL 设置层访问权限 修改层的权限。

实例

API

标题

API概述

ListInstances 列出函数实例 查询函数实例列表。

VPC绑定

API

标题

API概述

ListVpcBindings 列出VPC绑定配置 查询已创建的VPC连接。
CreateVpcBinding 创建VPC绑定 创建VPC连接。
DeleteVpcBinding 删除VPC绑定 删除指定VPC防火墙策略组的访问控制策略。

标签

API

标题

API概述

TagResources 设置资源标签 给指定资源打标签。
ListTagResources 查询资源标签关系 列出所有被打标签的资源。
UntagResources 删除资源标签 删除资源的标签。

异步任务

API

标题

API概述

GetAsyncTask 获取异步任务 获取指定异步任务详情。
ListAsyncTasks 获取异步任务列表 获取异步任务详情列表。
StopAsyncTask 停止异步任务 停止异步任务。

会话

API

标题

API概述

CreateSession 创建会话资源 创建一个显式会话资源。系统自动生成唯一 SessionID,预分配函数实例并绑定会话,支持指定 TTL 和 IdleTimeout。适用于 HEADER_FIELD 或 GENERATED_COOKIE 亲和类型,实现会话预热与配置初始化,调用后即可在 InvokeFunction 请求携带,用于路由请求。
ResumeSession 恢复会话 恢复会话
PauseSession 暂停会话 暂停/保存会话
GetSession 获取会话配置信息 获取指定会话的详细信息,包括 SessionID、关联函数、亲和类型、生命周期配置、状态及实例信息。用于查询单个会话当前元数据,支持按 functionName 和 qualifier 精确定位,便于外部系统监控与调试,仅支持查询 Active 状态的会话。
UpdateSession 更新会话配置 更新Active状态下的会话配置,如 SessionTTLInSeconds 和 SessionIdleTimeoutInSeconds 等生命周期配置。更新后生效,LastModifiedTime 自动刷新。可用于延长或缩短会话有效期,实现动态管理,不改变会话绑定的执行环境。
ListSessions 查询会话信息列表 列举指定函数下Active/Expired 状态的会话列表,支持按 qualifier、状态、会话ID过滤,分页查询。返回会话基础属性,用于批量查看会话分布与状态,助力运维监控和外部系统集成,提升会话可见性与管理能力。
DeleteSession 删除会话资源 删除指定会话,禁止新请求路由,会话元数据从数据库清除,客户携带相同 SessionID 的后续请求视为新会话。实现资源释放与会话清理。在会话隔离场景下,系统将中止运行的请求,释放会话绑定的实例。非会话隔离场景下,正在运行中的请求将继续运行,优雅终止。

其他

API

标题

API概述

PutScalingConfig 设置函数弹性配置 设置函数弹性配置。
DeleteScalingConfig 删除函数弹性配置 删除函数弹性配置
GetScalingConfig 获取函数弹性配置 获取函数弹性配置。
ListScalingConfigs 列出函数弹性配置 列出函数弹性配置。