Gunakan Alibaba Cloud CLI untuk memanggil operasi API ApsaraVideo Live - ApsaraVideo Live

Alibaba Cloud CLI adalah alat baris perintah serbaguna yang dikembangkan berdasarkan API. Anda dapat menggunakannya untuk menerapkan manajemen otomatis dan pemeliharaan ApsaraVideo Live. Topik ini menjelaskan cara menggunakan Alibaba Cloud CLI untuk memanggil operasi API ApsaraVideo Live. Dalam contoh ini, operasi DescribeLiveUserDomains dipanggil untuk menanyakan nama domain ApsaraVideo Live dalam akun.

Sebelum memulai

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

Langkah 1: Instal Alibaba Cloud CLI

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

Sistem operasi Windows: Windows.
Sistem operasi Linux: Linux.
Sistem operasi macOS: macOS.

Anda juga dapat menggunakan Cloud Shell untuk men-debug perintah yang ingin dijalankan di Alibaba Cloud CLI. Alibaba Cloud CLI terintegrasi ke dalam Cloud Shell, yang secara berkala memperbarui versi perangkat lunaknya. Untuk informasi lebih lanjut, lihat Apa itu Cloud Shell?.

Langkah 2: Konfigurasikan Alibaba Cloud CLI

Penting

Akun Alibaba Cloud memiliki izin 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 identitas Resource Access Management (RAM), memberikan izin yang diperlukan kepada identitas RAM berdasarkan prinsip hak istimewa minimal, dan kemudian menggunakan identitas RAM untuk memanggil operasi API. Untuk informasi lebih lanjut tentang kebijakan yang didukung oleh ApsaraVideo Live, lihat Kebijakan sistem ApsaraVideo Live dan Kebijakan kustom ApsaraVideo Live.

Sebelum menggunakan Alibaba Cloud CLI, Anda harus mengonfigurasi informasi seperti kredensial identitas dan ID wilayah di CLI. Alibaba Cloud CLI mendukung berbagai jenis kredensial identitas. Untuk informasi lebih lanjut, lihat Jenis Kredensial. Dalam contoh ini, pasangan AccessKey digunakan sebagai kredensial identitas.

Buat pengguna RAM dan buat pasangan AccessKey untuk pengguna RAM untuk mengonfigurasi kredensial identitas. Untuk informasi lebih lanjut, lihat Buat Pengguna RAM dan Buat Pasangan AccessKey.
Berikan izin yang diperlukan kepada pengguna RAM. Dalam contoh ini, lampirkan kebijakan AliyunLiveReadOnlyAccess kepada pengguna RAM. Kebijakan ini memberikan izin baca saja pada ApsaraVideo Live kepada pengguna RAM. Untuk informasi lebih lanjut, lihat Berikan Izin kepada Pengguna RAM.
Dapatkan ID wilayah tempat Anda ingin mengonfigurasi kredensial identitas. Alibaba Cloud CLI menggunakan ID wilayah tertentu untuk memulai panggilan API. Untuk informasi lebih lanjut tentang wilayah yang tersedia dari ApsaraVideo Live, lihat Endpoints.
Catatan
Ketika menggunakan Alibaba Cloud CLI, Anda dapat menggunakan opsi --region untuk menjalankan perintah di wilayah tertentu. Jika Anda menggunakan opsi ini, Alibaba Cloud CLI akan mengabaikan informasi wilayah dalam konfigurasi kredensial default dan pengaturan variabel lingkungan. Untuk informasi lebih lanjut, lihat Opsi Baris Perintah untuk Panggilan API.
Gunakan pasangan AccessKey pengguna RAM untuk mengonfigurasi kredensial AccessKey dalam profil bernama AkProfile. Untuk informasi lebih lanjut, lihat Contoh Konfigurasi.

Langkah 3: Hasilkan perintah CLI

Di OpenAPI Explorer, panggil operasi DescribeLiveUserDomains.
Di tab Parameters, konfigurasikan parameter. Kemudian, klik tab CLI Example untuk melihat contoh perintah CLI yang dihasilkan.
Salin perintah CLI atau debug perintah CLI di Cloud Shell.
- Klik ikon untuk memulai Cloud Shell dan debug perintah CLI di Cloud Shell.
- Klik ikon untuk menyalin perintah CLI ke clipboard. Anda juga dapat menempelkan perintah CLI ke shell lokal Anda untuk menjalankan perintah tersebut.
Catatan
Ketika menempelkan perintah CLI ke shell lokal Anda untuk debugging, perhatikan format parameternya. Untuk informasi lebih lanjut tentang format parameter yang diperlukan oleh Alibaba Cloud CLI, lihat Format Parameter.
Secara default, OpenAPI Explorer menambahkan opsi --region ke perintah CLI yang dihasilkan. Ketika Anda menyalin perintah ke shell Anda, Alibaba Cloud CLI mengabaikan informasi wilayah dalam konfigurasi kredensial identitas default dan pengaturan variabel lingkungan, serta menjalankan perintah di wilayah yang ditentukan dengan prioritas. Anda dapat menghapus atau menyimpan opsi tersebut sesuai dengan kebutuhan bisnis Anda.

Langkah 4: Panggil operasi API ApsaraVideo Live

Contoh 1: Tanyakan operasi API yang didukung oleh ApsaraVideo Live menggunakan Alibaba Cloud CLI

Contoh berikut menunjukkan cara menggunakan opsi --help untuk menanyakan operasi API yang didukung oleh ApsaraVideo Live. Anda juga dapat melihat operasi API yang didukung di Daftar Operasi Berdasarkan Fungsi.

Jalankan perintah berikut:
```
aliyun live --help
```
Lihat keluaran perintah.

Contoh 2: Tanyakan semua nama domain ApsaraVideo Live dalam akun

Contoh berikut menunjukkan cara menggunakan Alibaba Cloud CLI untuk memanggil operasi DescribeUserDomains dari ApsaraVideo Live untuk menanyakan semua nama domain dalam akun.

Jalankan perintah berikut:

aliyun live DescribeLiveUserDomains --LiveDomainType liveVideo

Lihat keluaran perintah.

{
  "Domains": {
    "PageData": [
      {
        "Cname": "learn.developer.aliyundoc.com",
        "Description": "test",
        "DomainName": "demo.aliyundoc.com",
        "GmtCreated": "2017-08-29T12:15:36Z",
        "GmtModified": "2017-12-29T12:15:36Z",
        "LiveDomainStatus": "online",
        "LiveDomainType": "liveVideo",
        "RegionName": "cn-beijing",
        "ResourceGroupId": ""
      }
    ]
  },
  "PageNumber": 1,
  "PageSize": 100,
  "RequestId": "E4EBD2BF-5EB0-4476-8829-9D94E1B15267",
  "TotalCount": 1
}

Catatan

Jika kesalahan dikembalikan setelah Anda memanggil operasi API ApsaraVideo Live, periksa apakah parameter input dan nilainya valid berdasarkan kode kesalahan.

Anda juga dapat melakukan diagnosis mandiri berdasarkan ID permintaan yang dikembalikan atau informasi kesalahan SDK di halaman Diagnosis Masalah OpenAPI.