Gunakan Alibaba Cloud CLI untuk memanggil operasi API Data Disaster Recovery - Data Management

Topik ini menjelaskan cara menggunakan Alibaba Cloud CLI untuk memanggil operasi API Data Disaster Recovery. Sebagai contoh, panggil operasi DescribeBackupPlanBilling untuk menanyakan informasi penagihan dari jadwal cadangan.

Sebelum Anda mulai

Alibaba Cloud CLI adalah alat baris perintah serbaguna yang dikembangkan berdasarkan API. Anda dapat menggunakannya untuk mengotomatiskan manajemen dan pemeliharaan Data Disaster Recovery. Untuk informasi lebih lanjut, lihat Apa itu Alibaba Cloud CLI?.

Untuk tugas kompleks, disarankan menyusun perintah ke dalam skrip shell dan menjalankannya guna meningkatkan efisiensi.

Langkah 1: Instal Alibaba Cloud CLI

Anda harus menginstal Alibaba Cloud CLI sebelum menggunakannya. CLI mendukung Windows, Linux, dan macOS. Pilih paket instalasi sesuai sistem operasi perangkat Anda. Untuk detail lebih lanjut, lihat:

Windows: Instal Alibaba Cloud CLI di Windows.
Linux: Instal Alibaba Cloud CLI di Linux.
macOS: Instal Alibaba Cloud CLI di macOS.

Alibaba Cloud CLI sudah terinstal sebelumnya di Cloud Shell. Cloud Shell secara otomatis mengonfigurasi kredensial identitas untuk Anda. Gunakan Cloud Shell untuk men-debug perintah yang ingin Anda jalankan di Alibaba Cloud CLI. 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 semua operasi API layanan Alibaba Cloud. Namun, penggunaan akun Alibaba Cloud untuk memanggil operasi API dapat menimbulkan risiko keamanan. Oleh karena itu, disarankan untuk membuat Pengguna Resource Access Management (RAM), memberikan izin yang diperlukan kepada pengguna RAM berdasarkan prinsip hak istimewa minimal, dan menggunakan pengguna RAM untuk memanggil operasi API. Untuk informasi lebih lanjut tentang kebijakan izin yang didukung oleh Data Disaster Recovery, lihat Kebijakan sistem yang telah ditentukan sebelumnya yang didukung oleh Data Disaster Recovery dan Kebijakan kustom untuk Data Disaster Recovery.

Sebelum menggunakan Alibaba Cloud CLI, tentukan informasi seperti kredensial identitas dan ID wilayah. CLI mendukung berbagai jenis kredensial identitas. Untuk informasi lebih lanjut, lihat bagian "Jenis Kredensial" dari topik Konfigurasikan kredensial. Anda dapat menggunakan AccessKey pair dari pengguna RAM untuk mengonfigurasi kredensial identitas. Ikuti langkah-langkah berikut:

Buat pengguna RAM dan pasangan AccessKey untuk mengonfigurasi kredensial identitas. Untuk informasi lebih lanjut, lihat Buat pengguna RAM dan bagian "Buat pasangan AccessKey untuk pengguna RAM" dari topik Buat pasangan AccessKey.
Berikan izin yang diperlukan kepada pengguna RAM. Dalam contoh ini, kebijakan AliyunDMSFullAccess dilampirkan pada pengguna RAM. Kebijakan ini memberikan izin untuk mengelola Data Disaster Recovery. Untuk informasi lebih lanjut, lihat Berikan izin kepada pengguna RAM.
Peroleh ID wilayah yang ingin digunakan untuk mengonfigurasi kredensial identitas. Alibaba Cloud CLI menggunakan ID wilayah yang Anda tentukan untuk memulai operasi API. Untuk informasi lebih lanjut tentang wilayah yang didukung oleh Data Disaster Recovery, lihat Endpoints.
Catatan
Saat menggunakan Alibaba Cloud CLI, Anda dapat menggunakan opsi --region untuk menjalankan perintah di wilayah tertentu. Jika Anda menggunakan opsi ini, CLI 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" dari topik Konfigurasikan kredensial.

Langkah 3: Hasilkan perintah CLI

Di OpenAPI Explorer, panggil operasi DescribeLiveUserDomains.
Pada tab Parameters, konfigurasikan parameter permintaan. 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 run the command in Cloud Shell. Anda dapat dengan cepat men-debug perintah di jendela Cloud Shell.
- Klik ikon untuk copy perintah contoh ke clipboard. Kemudian, tempelkan perintah contoh ke shell lokal Anda untuk menjalankan perintah tersebut.
Catatan
Saat menempelkan perintah CLI ke shell lokal Anda untuk debugging, perhatikan format parameternya. Untuk informasi lebih lanjut tentang format parameter Alibaba Cloud CLI, lihat Format parameter.
Secara default, OpenAPI Explorer menambahkan opsi --region ke perintah CLI yang dihasilkan. Saat Anda menyalin perintah ke shell lokal Anda, Alibaba Cloud CLI mengabaikan informasi wilayah dalam konfigurasi kredensial identitas default dan pengaturan variabel lingkungan, dan secara prioritas menggunakan wilayah yang ditentukan untuk menjalankan perintah. Anda dapat menghapus atau mempertahankan opsi ini berdasarkan kebutuhan bisnis Anda.

Langkah 4: Panggil operasi API dari Data Disaster Recovery

Catatan

Alibaba Cloud CLI mengintegrasikan operasi API Data Disaster Recovery versi 2019-03-06. Jika Anda ingin menggunakan versi lain dari operasi API, gunakan opsi --force dan --version untuk memulai pemanggilan paksa. Untuk informasi lebih lanjut, lihat Paksa panggil operasi API.
Saat perintah CLI dihasilkan di OpenAPI Explorer untuk operasi API Data Disaster Recovery versi 2021-01-01, opsi --force dan --version secara otomatis ditambahkan ke perintah CLI. Anda tidak perlu melakukan operasi ini secara manual.
Untuk informasi lebih lanjut, lihat Daftar operasi berdasarkan fungsi dan Daftar operasi berdasarkan fungsi.

Contoh 1: Tanyakan operasi API

Kode berikut memberikan contoh tentang cara menggunakan opsi --help untuk menanyakan operasi API Data Disaster Recovery versi 2019-03-06 yang dapat dipanggil di Alibaba Cloud CLI.

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

Contoh 2: Tanyakan informasi penagihan dari jadwal cadangan

Contoh berikut menunjukkan cara menggunakan Alibaba Cloud CLI untuk memanggil operasi DescribeBackupPlanBilling dari Data Disaster Recovery untuk menanyakan informasi penagihan dari jadwal cadangan. Untuk informasi lebih lanjut, lihat DescribeBackupPlanBilling.

Jalankan perintah berikut:

aliyun dbs DescribeBackupPlanBilling --BackupPlanId 'dbstooi01ex****' --ShowStorageType true

Lihat keluaran perintah.

{
  "HttpStatusCode": 200,
  "RequestId": "DD7BC7F5-4E3A-5DF3-BFF9-831503C4D9E3",
  "Success": true,
  "Item": {
    "BuyCreateTimestamp": 1658372830000,
    "FullStorageSize": 151,
    "BuyExpiredTimestamp": 1661097600000,
    "BuySpec": "micro",
    "QuotaEndTimestamp": 1659283200000,
    "IsExpired": true,
    "QuotaStartTimestamp": 1656604800000,
    "TotalFreeBytes": 858993459200,
    "PaiedBytes": 0,
    "UsedFullBytes": 0,
    "IsFreeBytesUnlimited": true,
    "ContStorageSize": 10437039,
    "BuyChargeType": "PREPAY",
    "UsedIncrementBytes": 9406734
  }
}

Catatan

Jika pesan kesalahan dikembalikan setelah Anda memanggil operasi API dari Data Disaster Recovery, periksa apakah parameter permintaan dan nilai parameter permintaan valid berdasarkan kode kesalahan.

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