API概览

本产品(云原生应用开发平台 FunctionAI/2023-07-14)的OpenAPI采用ROA签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(78410016550),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

工具集

API标题API概述
UpdateToolset更新工具集更新工具集信息
ListToolsets批量查询工具集批量查询工具集
GetToolset获取工具集获取某个工具集的信息
DeleteToolset删除工具集删除某个工具集
CreateToolset创建工具集创建工具集

模板

API标题API概述
RenderServicesByTemplate解析模板中的服务以及变量配置解析模板中的服务以及变量配置。

制品

API标题API概述
FetchArtifactDownloadUrl获取交付物临时下载地址获取交付物的zip包临时下载地址url
FetchArtifactTempBucketToken获取交付物临时上传令牌获取交付物临时上传的bucket、object和临时sts
GetArtifact查询交付物查询交付物
PutArtifact更新交付物更新交付物
DeleteArtifact删除交付物删除交付物
CreateArtifact创建交付物创建交付物存储

项目

API标题API概述
CreateProject创建项目创建项目,并在指定模板配置时自动部署此项目。
DeleteProject删除项目删除一个项目,并级联删除项目下的其他实体(包括环境、流水线触发器、流水线触发记录、流水线模板、流水线)。
UpdateProject修改项目修改项目,并在模板参数变化时自动部署该项目。
ListProjects批量查询项目批量查询满足条件的项目。
GetProject查询项目查询项目

环境

API标题API概述
DeployEnvironment部署环境手动触发环境部署。
GetEnvironmentDeployment查询环境部署详情查询环境部署信息
GetServiceDeployment查询服务部署详情查询服务部署信息
ListServiceDeployments批量查询服务部署信息批量查询服务部署信息。
PreviewEnvironment预览环境变更信息预览环境变更信息
CreateEnvironment创建环境创建项目下的环境,并可选地根据模板自动部署该环境。 服务会部署到指定的环境中,环境可以绑定代码仓库的某个分支或者某个项目模板。环境还可以设置基础设施堆栈,被环境下的所有服务所共享。
DeleteEnvironment删除环境删除一个环境,并级联删除项目下的其他实体(包括流水线触发器、流水线触发记录、流水线模板、流水线)。
UpdateEnvironment修改环境修改环境,并在模板参数变化时自动部署该环境。
ListEnvironments批量查询环境批量查询满足条件的环境。
GetEnvironment查询环境查询一个环境。

身份绑定

API标题API概述
DeleteConnection删除身份绑定删除一个身份绑定。
ListConnections批量查询身份绑定批量查询满足条件的身份绑定。

仓库绑定

API标题API概述
GetRepository查询仓库绑定查询一个仓库绑定实体。

流水线

API标题API概述
CreatePipeline创建流水线执行创建流水线执行。流水线将被异步地执行,并按照配置,产生具体的流水线任务。
ListPipelines批量查询流水线执行批量查询流水线执行。请尽可能提供更多的查询条件以缩小查询范围。
GetPipeline查询流水线执行查询流水线执行。
StartPipeline启动流水线执行启动流水线执行。
CancelPipeline取消流水线执行取消流水线执行。流水线以及任务将被尽快取消执行。
PutPipelineStatus替换流水线执行状态替换流水线执行状态。

流水线任务

API标题API概述
CreateTask创建流水线任务执行创建流水线任务执行。
ListTasks批量查询流水线任务执行批量查询流水线任务执行。
GetTask查询流水线任务执行查询流水线任务执行。
StartTask启动流水线任务执行启动流水线任务执行。
RetryTask重试流水线任务执行重试流水线任务执行。
ResumeTask恢复流水线任务执行恢复流水线任务执行。
CancelTask取消流水线任务执行取消流水线任务执行。
PutTaskStatus替换流水线任务执行状态替换流水线任务执行状态。

其他

API标题API概述
ActivateConnection激活身份绑定激活一个身份绑定。点击Connection状态中的授权链接完成OAuth授权流程后,开发平台会激活当前身份绑定。 使用OAuth授权的第三方代码托管平台包括:GitHub、Gitee、Codeup。
FetchConnectionCredential获取身份绑定凭证获取完成授权流程的身份绑定凭证,开发平台会使用该凭证访问第三方代码托管平台。