Ekspor Metadata API - Alibaba Cloud CLI

Alibaba Cloud CLI mendukung ekspor metadata perintah dan Metadata API. Topik ini menjelaskan langkah-langkah untuk mengekspor metadata.

Peringatan

Metadata API dari layanan cloud adalah kumpulan semua informasi deskriptif terkait API-nya. Untuk informasi lebih lanjut, lihat Metadata API.
Fitur ekspor metadata hanya untuk tujuan debugging atau pengembangan. Kami sarankan Anda menonaktifkan fitur ini setelah ekspor selesai.
Secara default, file metadata disimpan di direktori kerja skrip shell. Untuk mengubah jalur penyimpanan, pindahkan direktori kerja ke jalur target.
Jika direktori cli-metadata tidak dibuat, pastikan bahwa Anda telah berhasil menjalankan perintah Alibaba Cloud CLI, dan periksa apakah pengguna saat ini memiliki izin tulis untuk direktori kerja skrip shell.
Metadata berubah dengan pembaruan Alibaba Cloud CLI. Kami sarankan Anda meningkatkan Alibaba Cloud CLI ke versi terbaru sebelum mengekspor metadata.

Prosedur

Langkah 1: Aktifkan fitur ekspor

Tetapkan variabel lingkungan sementara GENERATE_METADATA menjadi YES di lingkungan eksekusi shell Anda untuk mengaktifkan fitur ekspor metadata.

Metode untuk menetapkan variabel berbeda menurut sistem operasi:

Linux/macOS
```
export GENERATE_METADATA=YES
```
Windows PowerShell
```
$env:GENERATE_METADATA = "YES"
```
Windows CMD
```
set GENERATE_METADATA=YES
```

Langkah 2: Ekspor metadata

Setelah Anda menetapkan variabel lingkungan, jalankan perintah Alibaba Cloud CLI apa pun. Alibaba Cloud CLI mulai mengekspor metadata setelah perintah dijalankan. Sebagai contoh:

aliyun

Semua file metadata yang dihasilkan disimpan di direktori cli-metadata dalam direktori kerja saat ini. Sebagai contoh:

Jika Anda menjalankan perintah di direktori C:\Users\User, metadata akan disimpan ke C:\Users\User\cli-metadata.
Jika Anda menjalankan perintah di direktori /home/user/, metadata akan disimpan ke /home/user/cli-metadata.

File metadata yang dihasilkan mencakup subdirektori dan file utama berikut, yang menyimpan berbagai jenis informasi metadata:

cli-metadata/
├── metadatas/ # Direktori untuk semua metadata API dari layanan cloud yang didukung oleh Alibaba Cloud CLI.
│ ├── products.json # Daftar dan informasi dasar layanan cloud, termasuk nama layanan, titik akhir, versi API terintegrasi default, gaya API, dan daftar API layanan.
│ └ ── <product-name>/ # Subdirektori untuk setiap layanan, seperti VPC dan ECS.
│ └ ── <api-name>.json # File definisi rinci untuk setiap operasi API.
│
├── en-US/ # Direktori untuk semua metadata API dari layanan cloud yang didukung oleh Alibaba Cloud CLI (versi Inggris). Layanan tanpa deskripsi dalam bahasa Inggris tidak ada di direktori ini.
│ ├── products.json # Daftar dan informasi dasar layanan cloud.
│ └ ── <product-name>/ # Subdirektori untuk setiap layanan, seperti VPC dan ECS.
│ ├── <api-name>.json # File definisi rinci untuk setiap operasi API.
│ └ ── version.json # Versi API yang didukung oleh layanan cloud dan daftar operasi API yang termasuk dalam setiap versi.
│
├── zh-CN/ # Direktori untuk semua metadata API dari layanan cloud yang didukung oleh Alibaba Cloud CLI (versi Cina). Layanan tanpa deskripsi dalam bahasa Cina tidak ada di direktori ini.
│ ├── products.json
│ └── <product-name>/
│ ├── <api-name>.json
│ └── version.json
│   
├── commands.json # File definisi untuk struktur perintah Alibaba Cloud CLI, termasuk semua perintah, subperintah, opsi, dan deskripsi parameter mereka.
└ ── version # Nomor versi Alibaba Cloud CLI yang digunakan saat ini (file teks biasa).

Langkah 3: Nonaktifkan fitur ekspor metadata

Setelah ekspor metadata selesai, nonaktifkan fitur ini untuk mencegah pembuatan file metadata saat Anda menjalankan perintah berikutnya.

Metode 1: Mulai ulang sesi shell

Tutup jendela terminal saat ini dan buka sesi shell baru untuk menghapus variabel lingkungan secara otomatis.

Metode 2: Hapus manual variabel lingkungan sementara

Linux/macOS
```
unset GENERATE_METADATA
```
Windows PowerShell
```
$env:GENERATE_METADATA = ""
```
Windows CMD
```
set GENERATE_METADATA=
```