Gunakan operasi API dengan Alibaba Cloud CLI - CloudOps Orchestration Service

CLI Alibaba Cloud adalah alat baris perintah serbaguna yang dikembangkan berdasarkan OpenAPI. Anda dapat menggunakan CLI Alibaba Cloud untuk mengotomatiskan manajemen dan pemeliharaan di CloudOps Orchestration Service. Topik ini menjelaskan cara menggunakan CLI Alibaba Cloud untuk memanggil API CloudOps Orchestration Service, disertai dengan beberapa contoh.

Sebelum Anda mulai

Untuk informasi lebih lanjut tentang CLI Alibaba Cloud, lihat Apa itu CLI Alibaba Cloud?

Instal CLI Alibaba Cloud

Anda harus menginstal CLI Alibaba Cloud sebelum menggunakannya. CLI Alibaba Cloud tersedia untuk sistem operasi Windows, Linux, dan macOS. Pilih paket instalasi sesuai dengan sistem operasi perangkat Anda. Untuk detail lebih lanjut, lihat topik-topik berikut:

Sistem operasi Windows: Instal CLI Alibaba Cloud di Windows
Sistem operasi Linux: Instal CLI Alibaba Cloud di Linux
Sistem operasi macOS: Instal CLI Alibaba Cloud di macOS

Anda juga dapat menggunakan Cloud Shell dari Alibaba Cloud untuk men-debug perintah yang ingin Anda jalankan di CLI Alibaba Cloud. Untuk informasi lebih lanjut tentang Cloud Shell, lihat Apa itu Cloud Shell?

Konfigurasikan CLI Alibaba Cloud

Penting

Akun Alibaba Cloud memiliki izin penuh untuk mengelola dan mengakses API semua layanan Alibaba Cloud. Jika Anda menggunakan akun utama untuk memanggil operasi API, risiko keamanan mungkin timbul. Kami merekomendasikan agar Anda membuat dan menggunakan Pengguna Resource Access Management (RAM) untuk memanggil operasi API atau melakukan operasi O&M rutin.

Sebelum menggunakan CLI Alibaba Cloud, konfigurasikan informasi seperti kredensial identitas dan ID wilayah di CLI Alibaba Cloud. CLI Alibaba Cloud mendukung berbagai jenis kredensial identitas. Untuk informasi lebih lanjut, lihat bagian "Jenis kredensial identitas" dalam topik Konfigurasikan kredensial identitas. Dalam contoh ini, digunakan kredensial AccessKey. Ikuti langkah-langkah berikut:

Buat pengguna RAM dan berikan izin kepada pengguna RAM untuk mengelola layanan Alibaba Cloud sesuai kebutuhan bisnis Anda. Untuk informasi lebih lanjut, lihat Buat pengguna RAM dan Gunakan RAM untuk kontrol akses.
Buat pasangan AccessKey untuk pengguna RAM dan catat ID AccessKey dan Rahasia AccessKey untuk konfigurasi kredensial identitas selanjutnya. Untuk informasi lebih lanjut, lihat Buat pasangan AccessKey.
Tentukan ID wilayah. CLI Alibaba Cloud memanggil operasi API di wilayah yang ditentukan. Untuk informasi lebih lanjut tentang wilayah yang tersedia, lihat Endpoints.
Catatan
Saat menggunakan CLI Alibaba Cloud, Anda dapat menentukan opsi --region untuk menjalankan perintah di wilayah tertentu. Jika Anda menentukan opsi ini, CLI Alibaba Cloud akan mengabaikan informasi wilayah dalam konfigurasi kredensial default dan pengaturan variabel lingkungan. Untuk informasi lebih lanjut, lihat Opsi baris perintah.
Gunakan pasangan AccessKey dari pengguna RAM untuk mengonfigurasi kredensial AccessKey di file konfigurasi bernama AkProfile. Untuk informasi lebih lanjut, lihat bagian "Contoh konfigurasi" dalam topik Konfigurasikan kredensial identitas.

Hasilkan perintah CLI

Kunjungi halaman Debugging API dari OOS.
Di kotak pencarian di sisi kiri halaman debugging API, cari operasi API yang ingin Anda panggil. Di tab Parameter dari operasi API, tentukan parameter berdasarkan referensi API. Klik tab Contoh CLI di sebelah kanan untuk melihat perintah sampel yang dihasilkan yang mencakup parameter yang telah ditentukan.
- Klik ikon untuk memulai Cloud Shell dan debug perintah di Cloud Shell.
- Klik ikon untuk menyalin perintah sampel ke clipboard. Lalu, tempelkan perintah sampel ke shell lokal Anda untuk menjalankan perintah tersebut.
  - Perhatikan format parameter saat Anda menempelkan perintah sampel ke shell lokal Anda untuk debugging. Untuk informasi lebih lanjut tentang format parameter dalam perintah CLI Alibaba Cloud, lihat Format parameter.
  - Secara default, opsi --region ditambahkan ke perintah sampel yang dihasilkan di OpenAPI Explorer. Saat Anda menyalin perintah ke shell lokal Anda, CLI Alibaba Cloud mengabaikan informasi wilayah dalam konfigurasi kredensial default dan pengaturan variabel lingkungan, serta secara prioritas menjalankan perintah di wilayah yang ditentukan. Anda dapat menghapus atau menyimpan opsi ini sesuai kebutuhan bisnis Anda.

Panggil operasi API

Sintaks

Di CLI Alibaba Cloud, gunakan sintaks berikut untuk menjalankan perintah. Untuk informasi lebih lanjut, lihat bagian "Sintaks" dalam topik Hasilkan dan jalankan perintah CLI.

aliyun <command> <subcommand> [opsi dan parameter]

Opsi perintah umum

Saat menggunakan CLI Alibaba Cloud, Anda dapat menentukan opsi perintah untuk mengubah perilaku perintah atau mengimplementasikan fitur tambahan. Berikut adalah opsi perintah umum yang digunakan:

--profile <profileName>: Gunakan opsi --profile dan parameter profileName untuk menentukan profil konfigurasi. Setelah menentukan profil konfigurasi yang valid, CLI Alibaba Cloud mengabaikan informasi dalam konfigurasi kredensial default dan pengaturan variabel lingkungan, serta secara prioritas menggunakan konfigurasi yang Anda tentukan untuk menjalankan perintah.
--help: Gunakan opsi --help untuk mendapatkan informasi bantuan tentang perintah. Untuk informasi lebih lanjut, lihat Gunakan perintah bantuan.

Untuk informasi lebih lanjut, lihat Opsi baris perintah.

Contoh kode

Contoh 1: Contoh kode berikut menjelaskan cara menggunakan opsi --help untuk mendapatkan daftar operasi API CloudOps Orchestration Service yang didukung oleh CLI Alibaba Cloud. Anda juga dapat melihat operasi API yang dapat dipanggil di Daftar operasi berdasarkan fungsi.

Jalankan perintah berikut:
```
aliyun oos --help
```
Lihat hasilnya.

Contoh 2: Contoh kode berikut menjelaskan cara menggunakan CLI Alibaba Cloud untuk memanggil operasi CreateTemplate dari OOS untuk membuat template bernama CLI_Template.

Jalankan perintah berikut:

Catatan

Format input parameter daftar array JSON bertipe string bervariasi tergantung pada sistem operasi Anda. Pilih dan jalankan perintah yang sesuai berdasarkan sistem operasi Anda. Untuk informasi lebih lanjut, lihat Format parameter.

Linux/macOS

aliyun oos CreateTemplate --RegionId 'cn-hangzhou' --TemplateName CLI_Template --Content '{"FormatVersion": "OOS-2019-06-01", "Description": "Describe instances of given status", "Parameters": {"Status": {"Type": "String", "Description": "(Required) The status of the Ecs instance."}}, "Tasks": [{"Properties": {"Parameters": {"Status": "{{ Status }}"}, "API": "DescribeInstances", "Service": "Ecs"}, "Name": "foo", "Action": "ACS::ExecuteApi"}]}'

Windows

aliyun oos CreateTemplate --RegionId 'cn-hangzhou' --TemplateName CLI_Template --Content "{'FormatVersion': 'OOS-2019-06-01', 'Description': 'Describe instances of given status', 'Parameters': {'Status': {'Type': 'String', 'Description': '(Required) The status of the Ecs instance.'}}, 'Tasks': [{'Properties': {'Parameters': {'Status': '{{ Status }}'}, 'API': 'DescribeInstances', 'Service': 'Ecs'}, 'Name': 'foo', 'Action': 'ACS::ExecuteApi'}]}"

Lihat hasilnya.

{
  "RequestId": "989F0944-E653-5826-9FA7-8ADE6E66F485",
  "Template": {
    "Description": "Describe instances of given status",
    "CreatedBy": "test(2039927162697*****)",
    "TemplateFormat": "JSON",
    "ResourceGroupId": "rg-acfmykd6*****",
    "UpdatedDate": "2024-08-05T10:28:24Z",
    "TemplateVersion": "v1",
    "Hash": "8abc5921b5a05051992*****",
    "UpdatedBy": "test(2039927162697*****)",
    "HasTrigger": false,
    "CreatedDate": "2024-08-05T10:28:24Z",
    "TemplateName": "CLI_Template",
    "Tags": {},
    "TemplateId": "t-9246d5246f*****",
    "ShareType": "Private"
  }
}

Catatan

Jika kesalahan dikembalikan setelah Anda memanggil operasi API CloudOps Orchestration Service, periksa apakah parameter masukan dan nilainya valid berdasarkan kode kesalahan.

Anda juga dapat menggunakan Alibaba Cloud OpenAPI Diagnostics untuk melakukan diagnosis mandiri berdasarkan ID permintaan yang dikembalikan atau informasi kesalahan.