Mulai Menggunakan Yunxiao CLI - Alibaba Cloud DevOps - Alibaba Cloud Documentation Center

Alibaba Cloud CLI adalah alat command-line yang dibangun di atas OpenAPI untuk mengelola layanan Apsara DevOps seperti Codeup (manajemen kode), Flow (pipeline), Packages (manajemen artefak), dan lainnya. Panduan cepat ini menjelaskan cara menginstal Alibaba Cloud CLI, mengonfigurasi kredensial Apsara DevOps, serta memanggil operasi Yunxiao OpenAPI. Contoh berikut menggunakan perintah flow-get-flow-tag-group untuk mengambil detail grup tag pipeline.

Prasyarat

Akun Alibaba Cloud
Organisasi Apsara DevOps (Yunxiao), Edisi Region
Token akses pribadi Yunxiao, yang Anda buat di Konsol Yunxiao. Untuk petunjuknya, lihat Obtain a personal access token.
(Opsional) Jika Anda baru mengenal Alibaba Cloud CLI, lihat What is Alibaba Cloud CLI.

Langkah 1: Instal Alibaba Cloud CLI

Instal Alibaba Cloud CLI sesuai sistem operasi Anda:

Catatan

Jika Anda telah menginstal Alibaba Cloud CLI, jalankan perintah berikut untuk memperbarui plugin Yunxiao ke versi yang mendukung Yunxiao OpenAPI terbaru:

aliyun plugin install --names aliyun-cli-devops

Anda juga dapat menggunakan Cloud Shell untuk menjalankan perintah Alibaba Cloud CLI tanpa instalasi lokal. Untuk informasi selengkapnya, lihat What is Cloud Shell.

Langkah 2: Konfigurasi Yunxiao CLI

Penting

Sistem identitas Apsara DevOps berbeda dari layanan Alibaba Cloud lainnya. Yunxiao tidak menggunakan profil (Pasangan Kunci Akses) untuk menyimpan kredensial. Sebagai gantinya, buat token akses pribadi di Konsol Yunxiao dan berikan melalui variabel lingkungan atau parameter command-line, bukan melalui aliyun configure.

Peroleh Token Akses Pribadi

Anda dapat menggunakan token akses pribadi untuk mengakses operasi API Yunxiao dan melakukan operasi Git melalui HTTP. Untuk informasi selengkapnya, lihat Obtain a personal access token.

Peringatan

Saat membuat token, pilih izin API minimum yang diperlukan dan atur periode validitas yang wajar. Jangan membuat token permanen.
Token hanya ditampilkan saat pertama kali dibuat. Anda tidak dapat melihat kembali token tersebut. Simpan token di lokasi yang aman.
Jangan memberikan token dalam bentuk teks biasa di command line. Kami menyarankan Anda menggunakan variabel lingkungan.
Jika token bocor, segera hapus token tersebut.

Konfigurasi Kredensial

Yunxiao CLI mendukung dua metode konfigurasi kredensial: variabel lingkungan dan parameter command-line.

Metode 1: Gunakan Variabel Lingkungan (Direkomendasikan)

Yunxiao CLI menggunakan variabel lingkungan berikut:

Variabel lingkungan	Deskripsi	Diperlukan (Edisi Region)
`ALIBABA_CLOUD_YUNXIAO_ACCESS_TOKEN`	Token akses pribadi Yunxiao	Ya
`ALIBABA_CLOUD_YUNXIAO_API_BASE_URL`	Titik akhir API	Ya
`ALIBABA_CLOUD_YUNXIAO_ORGANIZATION_ID`	Pengenal organisasi	Tidak

Contoh Edisi Region:

export ALIBABA_CLOUD_YUNXIAO_ACCESS_TOKEN=<your-personal-access-token>
export ALIBABA_CLOUD_YUNXIAO_API_BASE_URL=<your-api-base-url>

Metode 2: Gunakan Parameter Command-Line

Anda juga dapat memberikan kredensial sebagai parameter pada setiap perintah:

Parameter	Deskripsi	Diperlukan (Edisi Region)
`--yunxiao-access-token`	Token akses pribadi Yunxiao	Ya
`--api-base-url`	Titik akhir API	Ya
`--organization-id`	Pengenal organisasi	Tidak

Contoh Edisi Region:

aliyun devops flow-get-flow-tag-group --id 0 \
  --api-base-url=<your-api-base-url> \
  --yunxiao-access-token=<your-personal-access-token>

Verifikasi Konfigurasi Anda

Jalankan perintah berikut untuk memverifikasi bahwa plugin Yunxiao CLI tersedia:

aliyun devops version

Jika perintah mengembalikan informasi versi tanpa error, lingkungan Anda siap digunakan.

Langkah 3: Panggil Operasi API

Contoh 1: Daftar Perintah yang Tersedia

Jalankan perintah berikut untuk melihat semua perintah Yunxiao CLI:

aliyun devops --help

Output berikut dikembalikan (sebagian):

Description: Aliyun CLI plugin for yunxiao operations.

Usage: aliyun devops <command> [flags]

Available Commands:
  app-stack-create-application        Create an application
  app-stack-list-applications         List applications
  codeup-create-repository            Create a code repository
  codeup-list-repositories            List code repositories
  flow-create-pipeline                Create a pipeline
  flow-list-pipelines                 List pipelines
  flow-get-flow-tag-group             Get pipeline tag group details
  projex-search-projects              Search projects
  projex-search-workitems             Search work items
  ...

Yunxiao CLI mencakup modul-modul berikut:

Awalan modul	Deskripsi
`app-stack-*`	AppStack (pengiriman aplikasi)
`base-*`	Base (organisasi, anggota, dan peran)
`codeup-*`	Codeup (manajemen kode)
`flow-*`	Flow (pipeline)
`insight-*`	Insight (analitik efisiensi)
`packages-*`	Packages (manajemen artefak)
`projex-*`	Projex (kolaborasi proyek)
`test-hub-*`	TestHub (manajemen pengujian)

Catatan

Di situs Internasional (alibabacloud.com), hanya modul Codeup, Flow, dan Packages yang tersedia. Perintah dengan awalan projex-*, test-hub-*, app-stack-*, dan insight-* tidak didukung di situs Internasional.

Contoh 2: Dapatkan Detail Grup Tag Pipeline

Contoh berikut memanggil perintah flow-get-flow-tag-group untuk mendapatkan detail grup tag pipeline.

# Edisi Region (variabel lingkungan)
export ALIBABA_CLOUD_YUNXIAO_ACCESS_TOKEN=<your-personal-access-token>
export ALIBABA_CLOUD_YUNXIAO_API_BASE_URL=<your-api-base-url>

aliyun devops flow-get-flow-tag-group --id 0

Contoh respons:

{
  "id": 0,
  "name": "Environment Tags",
  "tags": [
    {
      "id": 1,
      "name": "Production",
      "color": "#FF6B6B"
    },
    {
      "id": 2,
      "name": "Staging",
      "color": "#4ECDC4"
    }
  ]
}

Catatan

Jika terjadi error saat memanggil operasi Yunxiao OpenAPI, periksa penyebab umum berikut:

Token tidak valid atau kedaluwarsa — Pastikan token akses pribadi Anda masih valid dan memiliki izin yang diperlukan.
Titik akhir salah — Pastikan Anda menggunakan titik akhir API yang benar sesuai edisi Anda.
Parameter yang diperlukan tidak ada — Edisi Central memerlukan --organization-id. Edisi Region memerlukan --api-base-url.

Contoh Lainnya

Contoh berikut menunjukkan operasi umum Yunxiao CLI.

Daftar repositori kode

aliyun devops codeup-list-repositories --page 1 --per-page 20

Cari proyek

aliyun devops projex-search-projects --page 1 --per-page 10

Daftar pipeline

aliyun devops flow-list-pipelines --page 1 --per-page 20

Daftar aplikasi

aliyun devops app-stack-list-applications --pagination '{"page":1,"perPage":20}' --order-by createdAt

Filter output menggunakan JMESPath

aliyun devops codeup-list-repositories --cli-query 'result[].{name:name,id:id}'