alicloud-platform-devops

Category: サービス

Alibaba Cloud DevOps（Yunxiao）

目的

Alibaba Cloud DevOps OpenAPI を使用して、以下をサポートします。

• プロジェクト、リポジトリ、パイプラインの一覧確認
• 作業項目とテストリソースの調査
• リリースと実行ステータスの確認
• 本番環境で変更を行う前のメタデータに基づく API 検索

前提条件

• 最小権限の Alibaba Cloud 認証情報を設定します。
• ローカルスクリプト用の 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. 共有認証情報ファイル：~/.alibabacloud/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：1 つの組織内のプロジェクトを一覧表示します。
• scripts/list_repositories.py：1 つの組織内のリポジトリを一覧表示します。
• scripts/list_pipelines.py：1 つの組織内のパイプラインを一覧表示します。

検証

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