本产品（
Serverless开发平台/2023-07-14）的OpenAPI采用ROA签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（11370001915），在专家指导下进行签名对接。在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
项目
| API | 标题 | API概述 |
|---|---|---|
| CreateProject | 创建项目 | 创建项目，并在指定模板配置时自动部署此项目。 |
| DeleteProject | 删除项目 | 删除一个项目，并级联删除项目下的其他实体（包括环境、流水线触发器、流水线触发记录、流水线模板、流水线）。 |
| UpdateProject | 修改项目 | 修改项目，并在模板参数变化时自动部署该项目。 |
| PutProject | 替换项目 | 使用新的项目配置替换已有的项目配置，并在模板参数变化时自动部署该项目。 |
| ListProjects | 批量查询项目 | 批量查询满足条件的项目。 |
| GetProject | 查询项目 | 查询一个项目。 |
环境
| API | 标题 | API概述 |
|---|---|---|
| CreateEnvironment | 创建环境 | 创建项目下的环境，并可选地根据模板自动部署该环境。 服务会部署到指定的环境中，环境可以绑定代码仓库的某个分支或者某个项目模板。环境还可以设置基础设施堆栈，被环境下的所有服务所共享。 |
| DeleteEnvironment | 删除环境 | 删除一个环境，并级联删除项目下的其他实体（包括流水线触发器、流水线触发记录、流水线模板、流水线）。 |
| UpdateEnvironment | 修改环境 | 修改环境，并在模板参数变化时自动部署该环境。 |
| PutEnvironment | 替换环境 | 使用新的环境配置替换已有的环境配置；当开启自动部署时，会在模板参数变化时自动部署该环境。 |
| ListEnvironments | 批量查询环境 | 批量查询满足条件的环境。 |
| GetEnvironment | 查询环境 | 查询一个环境。 |
身份绑定
| API | 标题 | API概述 |
|---|---|---|
| CreateConnection | 创建身份绑定 | 创建一个身份绑定，将阿里云主账号与一个第三方代码托管平台（GitHub、Gitee、Codeup、...）的账号建立关联。 |
| DeleteConnection | 删除身份绑定 | 删除一个身份绑定。 |
| ListConnections | 批量查询身份绑定 | 批量查询满足条件的身份绑定。 |
| GetConnection | 查询身份绑定 | 查询一个身份绑定。 |
| RefreshConnection | 刷新身份绑定 | 刷新身份绑定。检查并按需刷新身份绑定中的凭证信息和代码托管平台账号信息，若刷新失败，则将状态转换为不可用。 |
仓库绑定
| API | 标题 | API概述 |
|---|---|---|
| CreateRepository | 创建仓库绑定 | 创建一个仓库绑定。将阿里云主账号与一个第三方代码托管平台（GitHub、Gitee、Codeup、...）的代码仓库建立关联。 |
| DeleteRepository | 删除仓库绑定 | 删除一个仓库绑定实体。 |
| ListRepositories | 批量查询仓库绑定 | 批量查询满足条件的仓库绑定。 |
| GetRepository | 查询仓库绑定 | 查询一个仓库绑定实体。 |
流水线触发器
| API | 标题 | API概述 |
|---|---|---|
| CreatePipelineTrigger | 创建流水线触发器 | 创建流水线触发器，描述流水线触发的条件以及触发后的执行行为。 |
| DeletePipelineTrigger | 删除流水线触发器 | 删除流水线触发器，删除后将不会有关联的流水线执行历史产生。 |
| UpdatePipelineTrigger | 修改流水线触发器 | 修改流水线触发器，您指定的可写字段将被更新，未指定或不可改的字段将保持不变。 |
| PutPipelineTrigger | 替换流水线触发器 | 使用新的流水线配置替换已有的流水线配置，不能修改的字段将被忽略。 |
| ListPipelineTriggers | 批量查询流水线触发器 | 批量查询流水线触发器。 |
| GetPipelineTrigger | 查询流水线触发器 | 查询流水线触发器。 |
流水线触发事件
| API | 标题 | API概述 |
|---|---|---|
| CreatePipelineTriggerEvent | 提交流水线触发事件 | 尝试提交流水线触发事件，不满足流水线触发器配置条件的触发事件将不会触发流水线运行。 |
| DeletePipelineTriggerEvent | 删除流水线触发历史 | 删除流水线触发历史。 |
| ListPipelineTriggerEvents | 批量查询流水线触发历史 | 批量查询流水线触发历史。 |
| GetPipelineTriggerEvent | 查询流水线触发历史 | 查询流水线触发历史。 |
流水线
| API | 标题 | API概述 |
|---|---|---|
| CreatePipeline | 创建流水线执行 | 创建流水线执行。流水线将被异步地执行，并按照配置，产生具体的流水线任务。 |
| ListPipelines | 批量查询流水线执行 | 批量查询流水线执行。请尽可能提供更多的查询条件以缩小查询范围。 |
| GetPipeline | 查询流水线执行 | 查询流水线执行。 |
| StartPipeline | 启动流水线执行 | 启动流水线执行。 |
| CancelPipeline | 取消流水线执行 | 取消流水线执行。流水线以及任务将被尽快取消执行。 |
| PutPipelineStatus | 替换流水线执行状态 | 替换流水线执行状态。 |
流水线任务
| API | 标题 | API概述 |
|---|---|---|
| CreateTask | 创建流水线任务执行 | 创建流水线任务执行。 |
| ListTasks | 批量查询流水线任务执行 | 批量查询流水线任务执行。 |
| GetTask | 查询流水线任务执行 | 查询流水线任务执行。 |
| StartTask | 启动流水线任务执行 | 启动流水线任务执行。 |
| RetryTask | 重试流水线任务执行 | 重试流水线任务执行。 |
| ResumeTask | 恢复流水线任务执行 | 恢复流水线任务执行。 |
| CancelTask | 取消流水线任务执行 | 取消流水线任务执行。 |
| PutTaskStatus | 替换流水线任务执行状态 | 替换流水线任务执行状态。 |