概述
- API 概览
- API 调用方式

概述

Zadig 除了支持 Zadig 开源版开发者 API 以外，还提供更多扩展 API 的支持，帮助开发者对接企业内部系统。如有更多需要，请联系官方 (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
工作流视图	获取工作流视图列表	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
	查看环境服务详情	测试环境：GET /openapi/environments/:envName/services/:serviceName 生产环境：GET /openapi/environments/production/:envName/services/:serviceName
	新建环境	测试环境：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
	列出事件	GET /openapi/environments/kube/events
管理服务	添加服务	测试环境：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
更新镜像	更新 Deployment 镜像	POST /openapi/environments/image/deployment/:envName
	更新 Statefulset 镜像	POST /openapi/environments/image/statefulset/:envName
	更新 Cronjob 镜像	POST /openapi/environments/image/cronjob/:envName
子环境	检查 Workload 的 K8S Service	GET /openapi/environments/:envName/check/workloads/k8sservices
	开启子环境	POST /openapi/environments/:envName/share/enable
	关闭子环境	DELETE /openapi/environments/:envName/share/enable
	检查子环境 Ready	GET /openapi/environments/:name/check/sharenv/:op/ready
	获取入口服务	GET /openapi/environments/:name/share/portal/:serviceName
	设置入口服务	POST /openapi/environments/:name/share/portal/:serviceName

服务

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 链接
列出集群信息	GET /openapi/system/cluster
更新指定集群	PUT /openapi/system/cluster/:id
删除指定集群	DELETE /openapi/system/cluster/:id
检查集群 Istio 安装	GET /openapi/cluster/istio/check/:id

镜像仓库

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

日志

API 功能描述	API 链接
查看容器实时日志	GET /openapi/logs/sse/pods/:podName/containers/:containerName

用户及权限

API 功能描述	API 链接
列出用户信息	GET /openapi/users
列出用户组信息	GET /openapi/user-groups
列出项目权限定义	GET /openapi/policy/resource-actions
列出角色信息	GET /openapi/policy/roles
获取角色详情	GET /openapi/policy/roles/:name
创建项目角色	POST /openapi/policy/roles
编辑项目角色	PUT /openapi/policy/roles/:name
删除项目角色	DELETE /openapi/policy/roles/:name
列出项目成员	GET /openapi/policy/role-bindings
增加项目成员	POST /openapi/policy/role-bindings
更新项目成员权限	POST /openapi/policy/role-bindings/user/:uid
删除项目成员	DELETE /openapi/policy/role-bindings/user/:uid
更新项目用户组权限	POST /openapi/policy/role-bindings/group/:gid
删除项目用户组成员	DELETE /openapi/policy/role-bindings/group/:gid

API 调用方式

第一步：获取 API Token

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

第二步：调用 API

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

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

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