Gunakan Alibaba Cloud CLI untuk memanggil OpenAPI ApsaraVideo Live - ApsaraVideo Live

Alibaba Cloud CLI adalah alat command-line umum yang dibangun di atas OpenAPI. Anda dapat menggunakannya untuk mengotomatiskan pengelolaan dan pemeliharaan resource ApsaraVideo Live. Topik ini menjelaskan cara memanggil operasi DescribeLiveUserDomains untuk mengkueri nama domain streaming sebagai contoh penggunaan Alibaba Cloud CLI dengan ApsaraVideo Live.

Sebelum memulai

Pahami terlebih dahulu Alibaba Cloud CLI. Untuk informasi selengkapnya, lihat Apa itu Alibaba Cloud CLI?

Langkah 1: Instal Alibaba Cloud CLI

Instal Alibaba Cloud CLI pada perangkat Anda. Pilih paket instalasi yang sesuai dengan sistem operasi Anda:

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

Sebagai alternatif, Anda dapat melakukan debug perintah CLI di Cloud Shell, yang telah memiliki Alibaba Cloud CLI bawaan dan selalu diperbarui. Untuk informasi selengkapnya, lihat Apa itu Cloud Shell?.

Langkah 2: Konfigurasi Alibaba Cloud CLI

Penting

Akun Alibaba Cloud memiliki akses penuh ke semua API layanan, yang menimbulkan risiko keamanan. Kami menyarankan Anda membuat identitas Resource Access Management (RAM), memberikan hanya izin yang diperlukan berdasarkan prinsip hak istimewa minimal, lalu menggunakan identitas RAM tersebut untuk memanggil operasi API. Untuk informasi selengkapnya mengenai kebijakan yang didukung oleh ApsaraVideo Live, lihat Kebijakan sistem ApsaraVideo Live dan Kebijakan kustom ApsaraVideo Live.

Sebelum menggunakan Alibaba Cloud CLI, konfigurasikan kredensial identitas dan ID wilayah. Alibaba Cloud CLI mendukung berbagai jenis kredensial. Untuk informasi selengkapnya, lihat Jenis kredensial. Contoh ini menggunakan Pasangan Kunci Akses (AccessKey pairs).

Buat Pengguna RAM dan buat Pasangan Kunci Akses untuk Pengguna RAM tersebut guna mengonfigurasi kredensial identitas. Untuk informasi selengkapnya, lihat Buat Pengguna RAM dan Buat Pasangan Kunci Akses.
Berikan izin yang diperlukan kepada Pengguna RAM. Dalam contoh ini, lampirkan kebijakan AliyunLiveReadOnlyAccess ke Pengguna RAM. Kebijakan ini memberikan izin read-only kepada Pengguna RAM atas ApsaraVideo Live. Untuk informasi selengkapnya, lihat Berikan izin kepada Pengguna RAM.
Dapatkan ID wilayah untuk panggilan API Anda. Untuk informasi selengkapnya mengenai wilayah yang tersedia untuk ApsaraVideo Live, lihat Endpoint.

Catatan
Anda dapat menggunakan opsi --region untuk menjalankan perintah di wilayah tertentu. Opsi ini menggantikan wilayah dalam konfigurasi kredensial default dan Variabel lingkungan. Untuk informasi selengkapnya, lihat Opsi command line untuk panggilan API.
Gunakan Pasangan Kunci Akses Pengguna RAM untuk mengonfigurasi kredensial AccessKey dalam profil bernama AkProfile. Untuk informasi selengkapnya, lihat Contoh konfigurasi.

Langkah 3: Hasilkan perintah CLI

Di OpenAPI Explorer, buka halaman debugging DescribeLiveUserDomains.
Pada tab Parameters, konfigurasikan parameter. Lalu, klik tab CLI Example untuk melihat contoh perintah CLI yang dihasilkan.
Salin perintah CLI atau lakukan debug perintah CLI di Cloud Shell.
- Klik ikon untuk memulai Cloud Shell dan lakukan debug perintah CLI di Cloud Shell.
- Klik ikon untuk menyalin perintah CLI ke clipboard. Anda juga dapat menempelkan perintah CLI tersebut ke shell lokal Anda untuk menjalankannya.
Catatan
Saat menempelkan perintah CLI ke shell lokal Anda, pastikan format parameternya sesuai persyaratan. Untuk informasi selengkapnya, lihat Format parameter.

OpenAPI Explorer secara default menambahkan opsi --region ke perintah CLI yang dihasilkan. Opsi ini menggantikan wilayah dalam konfigurasi kredensial default dan Variabel lingkungan. Anda dapat menghapusnya jika ingin menggunakan wilayah default.

Langkah 4: Panggil operasi API ApsaraVideo Live

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

Jalankan opsi --help untuk menampilkan daftar semua 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 output perintah.

Product: live (ApsaraVideo Live)
Version: 2016-11-01
Available Api List:
    AddCasterComponent            Adds a component to a caster.
    AddCasterEpisode              Adds an episode to a caster.
    AddCasterEpisodeGroup         Adds an episode group.
    AddCasterEpisodeGroupContent  Adds content to an episode group.
    AddCasterLayout               Adds a layout to a caster.
    AddCasterProgram              Adds a program to a caster.
    AddCasterVideoResource        Adds a video resource. The number of video resources is limited by the caster inputs.
    AddCustomLiveStreamTranscode  Adds a custom transcoding configuration.
    AddLiveAIProduceRules
    AddLiveAISubtitle
    AddLiveAppRecordConfig        Configures application-based recording and saves the output to OSS.
    AddLiveAppSnapshotConfig      Configures snapshot capturing. The configuration takes effect after you restart streaming.
    AddLiveAudioAuditConfig       Adds a configuration for audio moderation.
    AddLiveAudioAuditNotifyConfig Adds a callback configuration for audio moderation.
    AddLiveCenterTransfer         Adds a stream relay configuration in Live Center.
    AddLiveDetectNotifyConfig     Adds a callback URL for content moderation.
    AddLiveDomain                 Adds a domain name. You can add only one domain name at a time.
    AddLiveDomainMapping          Adds a mapping between a streaming domain and an ingest domain.
    AddLiveDomainPlayMapping      Adds a mapping between a primary streaming domain and a secondary streaming domain.

Contoh 2: Kueri semua nama domain ApsaraVideo Live dalam akun

Panggil operasi DescribeUserDomains dari ApsaraVideo Live untuk mengkueri semua nama domain streaming dalam akun Anda.

Jalankan perintah berikut:

aliyun live DescribeLiveUserDomains --LiveDomainType liveVideo

Lihat output 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 terjadi error saat memanggil operasi API ApsaraVideo Live, verifikasi parameter input dan nilainya berdasarkan kode kesalahan.

Anda juga dapat menyalin RequestId dari respons atau pesan error SDK dan menggunakan OpenAPI Diagnostic Platform untuk diagnostik self-service.