概述

Zadig 除了支持 Zadig 开源版开发者 API 以外，还提供更多扩展 API 的支持，帮助开发者对接企业内部系统。如有更多需要，请联系官方概述 - 图1 (opens new window)以获取更多支持。

API 概览

项目

API 功能描述API 链接
创建空项目POST /openapi/projects/project
创建项目并初始化POST /openapi/projects/project

工作流

模块API 功能描述API 链接
自定义工作流获取工作流列表GET /openapi/workflows
获取工作流任务列表GET /openapi/workflows/custom/:workflowName/tasks
获取工作流任务详情GET /openapi/workflows/custom/task
执行自定义工作流POST /openapi/workflows/custom/task
取消自定义工作流任务DELETE /openapi/workflows/custom/task
重试自定义工作流任务POST /openapi/workflows/custom/:workflowName/task/:taskID
审批自定义工作流POST /openapi/workflows/custom/task/approve
创建自定义工作流POST /api/aslan/workflow/v4
删除自定义工作流DELETE /openapi/workflows/custom
产品工作流获取工作流任务状态（通过 commitID 获取）GET /api/directory/workflowTask
获取工作流任务状态（通过任务 ID 获取）GET /openapi/workflows/product/:workflowName/task/:taskID
获取工作流任务列表GET /openapi/workflows/product/:workflowName/tasks
获取工作流任务详情GET /api/directory/workflowTask/id/:id/pipelines/:pipelineName
执行工作流POST /openapi/workflows/product/task
取消工作流任务POST /api/directory/workflowTask/id/:id/pipelines/:pipelineName/cancel
重试工作流任务POST /api/directory/workflowTask/id/:id/pipelines/:pipelineName/restart
删除工作流DELETE /openapi/workflows/product
工作流视图获取工作流视图列表GET /openapi/workflows/view
创建工作流视图POST /openapi/workflows/view
编辑工作流视图PUT /openapi/workflows/view/:viewName
删除工作流视图DELETE /openapi/workflows/view/:viewName

自定义任务

支持自定义开发工作流任务，实现任何自定义功能，参考文档：自定义任务。

环境

模块API 功能描述API 链接
环境增删改查查看环境列表GET /openapi/environments
查看环境详情测试环境：GET /openapi/environments/:envName
生产环境：GET /openapi/environments/production/:envName
创建环境测试环境：POST /openapi/environments
生产环境：POST /openapi/environments/production
编辑环境测试环境：PUT /openapi/environments/:envName
生产环境：PUT /openapi/environments/production/:envName
删除环境测试环境：DELETE /openapi/environments/:envName
生产环境：DELETE /openapi/environments/production/:envName
管理服务添加服务测试环境：POST /openapi/environments/service/yaml
生产环境：POST /openapi/environments/production/service/yaml
更新服务测试环境：PUT /openapi/environments/service/yaml
生产环境：PUT /openapi/environments/production/service/yaml
删除服务测试环境：DELETE /openapi/environments/service/yaml
生产环境：DELETE /openapi/environments/production/service/yaml
环境配置查看环境配置列表测试环境：GET /openapi/environments/:envName/envcfgs
生产环境：GET /openapi/environments/production/:envName/envcfgs
查看环境配置详情测试环境：GET /openapi/environments/:envName/envcfgs
生产环境：GET /openapi/environments/production/:envName/envcfgs
更新环境配置PUT /openapi/environments/envcfgs
删除环境配置测试环境：DELETE /openapi/environments/:envName/envcfgs
生产环境：DELETE /openapi/environments/production/:envName/envcfgs
全局变量查看全局变量测试环境：GET /openapi/environments/:envName/variable
生产环境：GET /openapi/environments/production/:envName/variable
更新全局变量测试环境：PUT /openapi/environments/:envName/variable
生产环境：PUT /openapi/environments/production/:envName/variable
服务实例调整副本数POST /openapi/environments/scale
重启服务实例POST /openapi/environments/:envName/service/:serviceName/restart

服务

API 功能描述API 链接
获取服务列表GET /openapi/service/yaml/services
获取服务详情测试服务：GET /openapi/service/yaml/:serviceName
生产服务：GET /openapi/service/yaml/production/:serviceName
获取服务的 YAML 内容GET /openapi/service/yaml/:serviceName
创建服务（使用模板）测试服务：POST /openapi/service/template/load/yaml
生产服务：POST /openapi/service/template/production/load/yaml
创建服务（手动输入）测试服务：POST /openapi/service/yaml/raw
生产服务：POST /openapi/service/yaml/production/raw
更新服务配置测试服务：PUT /openapi/service/yaml/:serviceName
生产服务：PUT /openapi/service/yaml/production/:serviceName
更新服务变量测试服务：PUT /openapi/service/yaml/:serviceName/variable
生产服务：PUT /openapi/service/yaml/production/:serviceName/variable
删除服务测试服务：DELETE /openapi/service/yaml/:serviceName
生产服务：DELETE /openapi/service/yaml/production/:serviceName

构建

API 功能描述API 链接
使用构建模板创建构建POST /openapi/build

代码扫描

API 功能描述API 链接
创建代码扫描POST /openapi/quality/codescan

制品管理

API 功能描述API 链接
获取版本列表GET /api/aslan/delivery/releases
获取交付物追踪信息GET /api/directory/dc/artifact

效能洞察

API 功能描述API 链接
数据概览GET /openapi/statistics/overview
构建数据统计GET /openapi/statistics/build
部署数据统计GET /openapi/statistics/deploy
测试数据统计GET /openapi/statistics/test
生产环境发布数据统计GET /openapi/statistics/v2/release

镜像仓库

API 功能描述API 链接
集成镜像仓库POST /openapi/system/registry

API 调用方式

第一步：获取 API Token

点击右上角用户，在菜单中选择 账号设置，复制 API Token。

API Token

第二步：调用 API

在请求的 HTTP Header 中，加入指定的 Authorization 信息，即可在 HTTP Client 中调用 Zadig API，示例如下：

提示：示例中的 yours.zadig.com 是 Zadig 系统访问地址，请求前请视实际情况替换。

  1. curl -H 'Authorization: Bearer your-token' http://yours.zadig.com/api/aslan/system/notification/subscribe