Gunakan API CDN melalui Alibaba Cloud CLI - CDN - Alibaba Cloud - CDN

Alibaba Cloud Command Line Interface (Alibaba Cloud CLI) adalah alat terpadu yang dibangun di atas OpenAPI Explorer. Anda dapat menggunakan Alibaba Cloud CLI untuk mengotomatisasi pengelolaan dan pemeliharaan Alibaba Cloud CDN. Topik ini menjelaskan cara memanggil operasi API Alibaba Cloud CDN dan menyediakan contoh-contohnya.

Prasyarat

Sebelum melanjutkan, pahami terlebih dahulu Alibaba Cloud CLI. Untuk informasi selengkapnya, lihat Apa itu Alibaba Cloud CLI?.

Instal Alibaba Cloud CLI

Anda harus menginstal Alibaba Cloud CLI sebelum menggunakannya. Alibaba Cloud CLI menyediakan installer untuk Windows, Linux, dan macOS. Pilih installer yang sesuai dengan sistem operasi Anda.

Anda juga dapat menggunakan Cloud Shell, yang disediakan oleh Alibaba Cloud, untuk melakukan debugging perintah Alibaba Cloud CLI. Untuk informasi selengkapnya tentang Cloud Shell, lihat Apa itu Cloud Shell?.

Konfigurasi Alibaba Cloud CLI

Penting

Akun Alibaba Cloud (akun root) memiliki akses administratif penuh ke layanan dan sumber daya Anda, yang menimbulkan risiko keamanan signifikan. Kami sangat menyarankan agar Anda membuat dan menggunakan RAM user untuk akses API atau operasional dan pemeliharaan (O&M) harian.

Sebelum menggunakan Alibaba Cloud CLI, Anda harus mengonfigurasi kredensial identitas dan ID wilayah. Alibaba Cloud CLI mendukung berbagai jenis kredensial identitas. Untuk informasi selengkapnya, lihat Konfigurasi dan kelola kredensial identitas. Topik ini menggunakan kredensial AccessKey (AK) sebagai contoh.

Buat RAM user dan berikan izin yang diperlukan. Untuk informasi selengkapnya, lihat Buat RAM user dan Berikan izin kepada RAM user.

Penting
Contoh ini mengharuskan Anda menyambungkan kebijakan AliyunCDNReadOnlyAccess ke RAM user. Anda juga dapat menyambungkan kebijakan AliyunCDNFullAccess, yang memberikan kontrol penuh untuk mengkueri dan memodifikasi nama domain Alibaba Cloud CDN, atau membuat kebijakan kustom. Untuk informasi selengkapnya, lihat Referensi kebijakan kustom CDN.
Setelah membuat dan memberi otorisasi pada RAM user, buat pasangan Kunci Akses. Catat AccessKey ID dan AccessKey Secret. Untuk informasi selengkapnya, lihat Buat AccessKey.
Dapatkan dan catat ID wilayah yang tersedia. Alibaba Cloud CLI mengirim permintaan API ke wilayah yang Anda tentukan. Untuk daftar wilayah yang tersedia, lihat Struktur permintaan.

Catatan
Anda dapat menggunakan opsi --region untuk menentukan wilayah untuk suatu perintah. Opsi ini mengesampingkan wilayah default yang dikonfigurasi dalam kredensial dan variabel lingkungan Anda. Untuk informasi selengkapnya, lihat Opsi command-line.
Gunakan pasangan Kunci Akses RAM user untuk mengonfigurasi kredensial. Beri nama profil konfigurasi AkProfile. Untuk informasi selengkapnya, lihat Endpoints.

Buat contoh perintah CLI

Buka halaman Debugging untuk API Alibaba Cloud CDN.
Pada kotak pencarian di sisi kiri, cari API yang ingin Anda gunakan. Di tab Parameters, konfigurasikan parameter sesuai dokumentasi API. Klik tab CLI Example untuk menghasilkan contoh perintah dengan parameter yang telah Anda konfigurasi.
- Klik ikon untuk membuka Cloud Shell dan lakukan debugging perintah tersebut.
- Klik ikon untuk menyalin contoh CLI. Kemudian, tempelkan ke shell lokal Anda untuk menjalankan perintah tersebut.
  - Saat menempelkan contoh CLI ke shell lokal untuk debugging, perhatikan format parameternya. Untuk informasi selengkapnya tentang format parameter perintah Alibaba Cloud CLI, lihat Pahami parameter perintah.
  - Secara default, OpenAPI Explorer menambahkan opsi --region ke contoh yang dihasilkan. Saat menjalankan perintah secara lokal, Alibaba Cloud CLI mengabaikan informasi wilayah dalam konfigurasi kredensial default dan variabel lingkungan Anda, serta memprioritaskan wilayah yang ditentukan. Anda dapat menghapus atau mempertahankan opsi ini sesuai kebutuhan.

Panggil operasi API

Struktur perintah

Struktur umum command-line Alibaba Cloud CLI adalah sebagai berikut. Untuk informasi selengkapnya, lihat Hasilkan dan panggil perintah.

aliyun <command> <subcommand> [options and parameters]

Opsi command-line umum

Anda dapat menggunakan opsi command-line di Alibaba Cloud CLI untuk memodifikasi perilaku default suatu perintah atau menambahkan fungsionalitas. Opsi umum meliputi:

--profile <profileName>: Jika Anda menggunakan opsi --profile dan menentukan nama konfigurasi yang valid untuk profileName, Alibaba Cloud CLI akan mengabaikan konfigurasi kredensial identitas default dan pengaturan variabel lingkungan, serta memprioritaskan konfigurasi yang ditentukan untuk menjalankan perintah tersebut.
--help: Tambahkan opsi --help ke suatu perintah untuk mendapatkan informasi bantuan terkait perintah tersebut. Untuk informasi selengkapnya, lihat Dapatkan informasi bantuan.

Untuk informasi selengkapnya, lihat Opsi command-line.

Contoh

Contoh berikut menunjukkan cara memanggil operasi DescribeUserDomains dari Alibaba Cloud CDN untuk mengkueri semua nama domain beserta statusnya di bawah akun Anda. Untuk informasi selengkapnya tentang operasi DescribeUserDomains, lihat DescribeUserDomains.

Jalankan perintah.

aliyun cdn DescribeUserDomains --DomainName mxxxio.top

Perintah tersebut mengembalikan output berikut.

{
  "Domains": {
    "PageData": [
      {
        "CdnType": "web",
        "Cname": "mxxx.xxxp.w.kunlunq.com",
        "Coverage": "domestic",
        "Description": "",
        "DomainId": 201xxx553,
        "DomainName": "mjlxxxao.top",
        "DomainStatus": "online",
        "GlobalResourcePlan": "off",
        "GmtCreated": "2024-08-27T06:29:36Z",
        "GmtModified": "2024-08-27T06:34:04Z",
        "ResourceGroupId": "rg-acfmwpdflelaoai",
        "Sandbox": "",
        "Sources": {
          "Source": [
            {
              "Content": "183.xxx.xxx.88.cn-hangzhou.sae.aliyuncs.com",
              "Port": 80,
              "Priority": "20",
              "Type": "domain",
              "Weight": "10"
            }
          ]
        }
      }
    ]
  },
  "PageNumber": 1,
  "PageSize": 20,
  "RequestId": "E4EBD2BF-5EB0-4044-9B97-xxxxxx",
  "TotalCount": 1
}
            }
          ]
        },
        "SslProtocol": "off"
      }
    ]
  },
  "PageNumber": 1,
  "PageSize": 20,
  "RequestId": "34C9E61F-02A0-5EB5-BBCB-16B531ABB9E0",
  "TotalCount": 1
}

Catatan

Jika pemanggilan API Alibaba Cloud CDN mengembalikan error, gunakan kode kesalahan yang dikembalikan untuk memverifikasi bahwa parameter permintaan dan nilainya valid.

Anda juga dapat menggunakan RequestId atau pesan error SDK dari respons bersama Alibaba Cloud OpenAPI Diagnostics untuk melakukan troubleshooting masalah tersebut.