Back to Details

alicloud-platform-devops

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese
Category: service
Category: service

Alibaba Cloud DevOps (Yunxiao)

阿里云DevOps（云效）

Purpose

用途

Use Alibaba Cloud DevOps OpenAPI to support:
  • project, repository, and pipeline inventory
  • work item and test resource inspection
  • release and execution status checks
  • metadata-driven API discovery before production changes
使用阿里云DevOps OpenAPI支持：
  • 项目、代码仓库和流水线的清单管理
  • 工作项和测试资源检查
  • 发布与执行状态核查
  • 生产变更前的元数据驱动API发现

Prerequisites

前提条件

  • Configure least-privilege Alibaba Cloud credentials.
  • Install Python SDK dependencies for local scripts:
bash
python3 -m venv .venv
. .venv/bin/activate
python -m pip install -U alibabacloud_devops20210625 alibabacloud_tea_openapi
  • Prefer environment variables: 
    • ALICLOUD_ACCESS_KEY_ID
    • ALICLOUD_ACCESS_KEY_SECRET
    • optional 
      ALICLOUD_REGION_ID
  • 配置最小权限的阿里云凭证。
  • 为本地脚本安装Python SDK依赖：
bash
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 Priority

AccessKey优先级

  1. Environment variables: 
    ALICLOUD_ACCESS_KEY_ID
    / 
    ALICLOUD_ACCESS_KEY_SECRET
    / 
    ALICLOUD_REGION_ID
  2. Shared credentials file: 
    ~/.alibabacloud/credentials
If region/environment is unclear, confirm with user before mutating operations.
  1. 环境变量：
    ALICLOUD_ACCESS_KEY_ID
    / 
    ALICLOUD_ACCESS_KEY_SECRET
    / 
    ALICLOUD_REGION_ID
  2. 共享凭证文件：
    ~/.alibabacloud/credentials
如果区域/环境不明确，在执行变更操作前请与用户确认。

Workflow

工作流程

  1. Confirm target organization/project scope and change window.
  2. Run API discovery and confirm exact API names and required parameters.
  3. Execute read-only APIs first (
    List*
    / 
    Get*
    / 
    Query*
    ).
  4. Run mutating APIs only after rollback and owner confirmation.
  5. Save outputs and evidence to 
    output/alicloud-platform-devops/
    .
  1. 确认目标组织/项目范围和变更窗口。
  2. 执行API发现，确认准确的API名称和所需参数。
  3. 先执行只读API（
    List*
    / 
    Get*
    / 
    Query*
    ）。
  4. 仅在确认回滚方案和获得所有者许可后，再执行变更类API。
  5. 将输出和证据保存至
    output/alicloud-platform-devops/
    。

API Discovery

API发现

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

Minimal Executable Quickstart

最简快速开始

bash
python skills/platform/devops/alicloud-platform-devops/scripts/list_openapi_meta_apis.py
Optional arguments:
bash
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
List projects (read-only):
bash
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
List repositories (read-only):
bash
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
List pipelines (read-only):
bash
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
bash
python skills/platform/devops/alicloud-platform-devops/scripts/list_openapi_meta_apis.py
可选参数：
bash
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
列出项目（只读）：
bash
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
列出代码仓库（只读）：
bash
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
列出流水线（只读）：
bash
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

Common Operation Map

常见操作映射

  • Project and membership: 
    CreateProject
    , 
    GetProject
    , 
    ListProjectMembers
    , 
    UpdateProject
  • Code repository: 
    CreateRepository
    , 
    GetRepository
    , 
    ListRepositories
    , 
    CreateMergeRequest
  • Pipeline and release: 
    CreatePipeline
    , 
    GetPipeline
    , 
    ListPipelines
    , 
    RunPipeline
  • Work items and test: 
    CreateWorkitem
    , 
    GetWorkitemDetail
    , 
    ListTestCase
    , 
    CreateTestCase
See 
references/api_quick_map.md
for grouped APIs.
  • 项目与成员：
    CreateProject
    , 
    GetProject
    , 
    ListProjectMembers
    , 
    UpdateProject
  • 代码仓库：
    CreateRepository
    , 
    GetRepository
    , 
    ListRepositories
    , 
    CreateMergeRequest
  • 流水线与发布：
    CreatePipeline
    , 
    GetPipeline
    , 
    ListPipelines
    , 
    RunPipeline
  • 工作项与测试：
    CreateWorkitem
    , 
    GetWorkitemDetail
    , 
    ListTestCase
    , 
    CreateTestCase
分组API详见
references/api_quick_map.md
。

Script Catalog

脚本目录

  • scripts/list_openapi_meta_apis.py
    : fetch metadata and generate API inventory files.
  • scripts/list_projects.py
    : list projects in one organization.
  • scripts/list_repositories.py
    : list repositories in one organization.
  • scripts/list_pipelines.py
    : list pipelines in one organization.
  • scripts/list_openapi_meta_apis.py
    ：获取元数据并生成API清单文件。
  • scripts/list_projects.py
    ：列出单个组织下的项目。
  • scripts/list_repositories.py
    ：列出单个组织下的代码仓库。
  • scripts/list_pipelines.py
    ：列出单个组织下的流水线。

Validation

验证

bash
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
Pass criteria: command exits 0 and 
output/alicloud-platform-devops/validate.txt
is generated.
bash
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
文件。

Output And Evidence

输出与证据

  • Save artifacts, command outputs, and API response summaries under 
    output/alicloud-platform-devops/
    .
  • Include key parameters (region/resource id/time range) in evidence files for reproducibility.
  • 将制品、命令输出和API响应摘要保存至
    output/alicloud-platform-devops/
    。
  • 在证据文件中包含关键参数（区域/资源ID/时间范围）以确保可复现性。

References

参考资料

  • Source list: 
    references/sources.md
  • API quick map: 
    references/api_quick_map.md
  • Operation templates: 
    references/templates.md
  • 来源列表：
    references/sources.md
  • API快速映射：
    references/api_quick_map.md
  • 操作模板：
    references/templates.md