SuperAPI AI 工具集

alicloud-platform-devops

部署与运维

查看项目

更新于 10-15 12:37

技能介绍

用途

阿里云 DevOps(云效 Yunxiao 2020)技能通过阿里云 DevOps OpenAPI 支持以下操作:

  • 项目、代码仓库和流水线的资源清单;
  • 工作项与测试资源的检查;
  • 发布与执行状态查询;
  • 在生产环境变更前进行元数据驱动的 API 发现。

前置条件

  • 配置最小权限的阿里云凭证。
  • 为本地脚本安装 Python SDK 依赖,安装命令如下:
python3 -m venv .venv
. .venv/bin/activate
python -m pip install -U alibabacloud_devops20210625 alibabacloud_tea_openapi
  • 凭证优先使用环境变量:
    • ALICLOUD_ACCESS_KEY_ID
    • ALICLOUD_ACCESS_KEY_SECRET
    • 可选的 ALICLOUD_REGION_ID

AccessKey 优先级:

  1. 环境变量:ALICLOUD_ACCESS_KEY_ID / ALICLOUD_ACCESS_KEY_SECRET / ALICLOUD_REGION_ID
  2. 共享凭证文件:~/.alicloud/credentials

如果区域/环境不明确,在执行变更操作前需与用户确认。

工作流程

  1. 确认目标组织/项目范围与变更窗口。
  2. 运行 API 发现,确认准确的 API 名称和必需参数。
  3. 先执行只读 API(List* / Get* / Query*)。
  4. 仅在具备回滚方案和所有者确认后,才执行变更类 API。
  5. 将输出和证据保存到 output/alicloud-platform-devops/。

API 发现

  • 产品代码:devops
  • 默认 API 版本:2021-06-25
  • 元数据来源:https://api.aliyun.com/meta/v1/products/devops/versions/2021-06-25/api-docs.json

最小可执行快速开始

python skills/platform/devops/alicloud-platform-devops/scripts/list_openapi_meta_apis.py

可选参数:

python skills/platform/devops/alicloud-platform-devops/scripts/list_openapi_meta_apis.py \
  --product-code devops \
  --version 2021-06-25 \
  --output-dir output/alicloud-platform-devops

列出项目(只读):

python skills/platform/devops/alicloud-platform-devops/scripts/list_projects.py \
  --organization-id <organization-id> \
  --region cn-hangzhou \
  --max-results 20 \
  --output output/alicloud-platform-devops/projects.txt

列出代码仓库(只读):

python skills/platform/devops/alicloud-platform-devops/scripts/list_repositories.py \
  --organization-id <organization-id> \
  --region cn-hangzhou \
  --page 1 \
  --per-page 20 \
  --output output/alicloud-platform-devops/repositories.txt

列出流水线(只读):

python skills/platform/devops/alicloud-platform-devops/scripts/list_pipelines.py \
  --organization-id <organization-id> \
  --region cn-hangzhou \
  --max-results 20 \
  --output output/alicloud-platform-devops/pipelines.txt

常用操作映射

  • 项目与成员:CreateProject、GetProject、ListProjectMembers、UpdateProject
  • 代码仓库:CreateRepository、GetRepository、ListRepositories、CreateMergeRequest
  • 流水线与发布:CreatePipeline、GetPipeline、ListPipelines、RunPipeline
  • 工作项与测试:CreateWorkitem、GetWorkitemDetail、ListTestCase、CreateTestCase

分组 API 详见 references/api_quick_map.md。

脚本目录

  • scripts/list_openapi_meta_apis.py:获取元数据并生成 API 清单文件。
  • scripts/list_projects.py:列出某个组织下的项目。
  • scripts/list_repositories.py:列出某个组织下的代码仓库。
  • scripts/list_pipelines.py:列出某个组织下的流水线。

验证

mkdir -p output/alicloud-platform-devops
for f in skills/platform/devops/alicloud-platform-devops/scripts/*.py; do
  python3 -m py_compile "$f"
done
echo "py_compile_ok" > output/alicloud-platform-devops/validate.txt

通过标准:命令退出码为 0 且生成 output/alicloud-platform-devops/validate.txt。

输出与证据

  • 将产物、命令输出和 API 响应摘要保存到 output/alicloud-platform-devops/ 下。
  • 在证据文件中包含关键参数(区域/资源 ID/时间范围)以便复现。

参考

  • 来源列表:references/sources.md
  • API 快速映射:references/api_quick_map.md
  • 操作模板:references/templates.md

适用场景

适用于需要批量查看阿里云云效中的项目、代码仓库、流水线、工作项与测试资源,或需要安全地执行生产变更前进行 API 发现与检查的场景。

限制

  • 需配置阿里云凭证,且建议使用最小权限。
  • 变更类操作需在确认回滚方案和所有者同意后执行。
  • 区域/环境不明确时,执行变更前必须与用户确认。
  • 关于收费、价格、平台或效果等信息暂未提供。