Referensi CLI - Certificate Management Service - Alibaba Cloud Documentation Center

Topik ini menggunakan contoh pemanggilan API ListDeploymentJob dari Certificate Management Service (Original SSL Certificate) untuk mengambil daftar pekerjaan penerapan guna menunjukkan cara menggunakan Alibaba Cloud CLI untuk memanggil OpenAPI Certificate Management Service.

Konsep

Alibaba Cloud Command Line Interface (CLI) adalah alat baris perintah umum yang dibangun di atas OpenAPI. CLI membantu mengotomatiskan pengelolaan dan pemeliharaan Certificate Management Service. Untuk informasi selengkapnya, lihat Apa itu Alibaba Cloud CLI?.

Langkah 1: Instal Alibaba Cloud CLI

Sebelum menggunakan Alibaba Cloud CLI, Anda harus menginstalnya terlebih dahulu. Anda dapat menginstal Alibaba Cloud CLI pada Windows, Linux, dan macOS. Pilih metode instalasi yang sesuai dengan sistem operasi Anda.

Cloud Shell telah dilengkapi Alibaba Cloud CLI yang pra-instal dan diperbarui secara berkala. Anda dapat menggunakan Cloud Shell untuk melakukan debug perintah Alibaba Cloud CLI. Untuk informasi selengkapnya, lihat Apa itu Cloud Shell?.

Langkah 2: Konfigurasikan Alibaba Cloud CLI

Penting

Akun Alibaba Cloud memiliki izin untuk mengelola dan mengakses semua operasi OpenAPI produk. Hal ini menimbulkan risiko keamanan yang tinggi. Kami menyarankan agar Anda membuat pengguna Resource Access Management (RAM), memberikan izin kepada pengguna RAM tersebut berdasarkan prinsip hak istimewa minimal, lalu menggunakan pengguna RAM tersebut untuk mengakses OpenAPI. Untuk informasi selengkapnya mengenai kebijakan akses yang didukung oleh Certificate Management Service, lihat Kebijakan sistem untuk Certificate Management Service.

Sebelum menggunakan CLI, Anda harus mengonfigurasi kredensial identitas dan ID wilayah. CLI mendukung berbagai jenis kredensial identitas. Untuk informasi selengkapnya, lihat Jenis kredensial. Contoh ini menunjukkan cara menggunakan pasangan AccessKey pengguna RAM untuk mengonfigurasi kredensial AK. Prosedurnya sebagai berikut:

Buat pengguna RAM dan pasangan AccessKey untuk mengonfigurasi kredensial identitas. Untuk informasi selengkapnya, lihat Buat pengguna RAM dan Buat pasangan AccessKey.
Berikan izin kepada pengguna RAM. Dalam contoh ini, Anda memberikan izin read-only untuk Certificate Management Service: AliyunYundunCertReadOnlyAccess. Untuk informasi selengkapnya, lihat Kelola izin pengguna RAM.
Dapatkan ID wilayah yang tersedia untuk mengonfigurasi kredensial identitas Anda. CLI menggunakan wilayah yang Anda tentukan untuk melakukan panggilan OpenAPI. Untuk informasi selengkapnya mengenai wilayah yang tersedia untuk Certificate Management Service, lihat Endpoint.

Catatan
Saat menggunakan CLI, Anda dapat menggunakan opsi --region untuk menentukan wilayah tertentu dalam suatu perintah. Opsi ini akan menggantikan informasi wilayah dalam konfigurasi kredensial default dan variabel lingkungan. Untuk informasi selengkapnya, lihat Opsi baris perintah.
Gunakan pasangan AccessKey pengguna RAM untuk mengonfigurasi kredensial AK. Beri nama file konfigurasi tersebut AkProfile. Untuk informasi selengkapnya, lihat Contoh konfigurasi.

Langkah 3: Hasilkan contoh perintah CLI

Di Portal OpenAPI, buka halaman debug ListDeploymentJob.
Pada tab Parameter settings, masukkan parameter permintaan. Klik tab CLI Example untuk melihat contoh CLI yang dihasilkan.
Salin contoh CLI atau jalankan di Cloud Shell:
- Klik tombol Run Command untuk membuka Cloud Shell dan langsung melakukan debug perintah tersebut.
- Klik tombol Copy untuk menyalin contoh CLI ke clipboard. Anda kemudian dapat menempelkannya ke tool shell lokal untuk menjalankan perintah atau menulis skrip baris perintah.
Catatan
- Saat menyalin contoh CLI ke tool shell lokal untuk debugging, perhatikan format parameternya. Untuk informasi selengkapnya mengenai format parameter perintah Alibaba Cloud CLI, lihat Format parameter.
- Contoh yang dihasilkan di Portal OpenAPI secara default menyertakan opsi --region. Saat Anda menyalin perintah tersebut untuk dijalankan secara lokal, CLI akan mengabaikan informasi wilayah dalam konfigurasi kredensial default dan variabel lingkungan, serta menggunakan wilayah yang ditentukan untuk menjalankan perintah. Anda dapat menghapus atau mempertahankan opsi ini sesuai kebutuhan.

Langkah 4: Panggil operasi Certificate Management Service OpenAPI

Contoh 1: Dapatkan daftar operasi Certificate Management Service OpenAPI yang dapat dipanggil menggunakan CLI

Contoh berikut menunjukkan cara menggunakan opsi --help untuk mendapatkan daftar operasi OpenAPI Certificate Management Service yang dapat Anda panggil menggunakan CLI. Untuk informasi selengkapnya, lihat Ikhtisar API.

Catatan

Anda dapat menggunakan opsi --force dan --version untuk memanggil operasi OpenAPI untuk sertifikat pribadi (Certificate Management Service/2020-06-30). Untuk informasi selengkapnya, lihat Paksa pemanggilan API.
Saat Portal OpenAPI menghasilkan contoh perintah untuk operasi OpenAPI sertifikat pribadi (Certificate Management Service/2020-06-30), portal secara otomatis menambahkan opsi --force dan --version. Anda tidak perlu menambahkannya secara manual.
Untuk informasi selengkapnya mengenai OpenAPI untuk sertifikat pribadi (Certificate Management Service/2020-06-30), lihat Ikhtisar API.

Jalankan perintah berikut.
```
aliyun cas --help
```
Output yang diharapkan.

Contoh 2: Dapatkan daftar pekerjaan penerapan

Contoh berikut menunjukkan cara menggunakan CLI untuk memanggil operasi API ListDeploymentJob dari Certificate Management Service guna mendapatkan daftar pekerjaan penerapan berdasarkan tipe pekerjaan dan status pekerjaan.

Jalankan perintah berikut.

aliyun cas ListDeploymentJob --JobType user --Status pending

Output yang diharapkan.

{
  "RequestId": "12345678-1234-1234-1234-123456789ABC",
  "Total": 7,
  "CurrentPage": 1,
  "ShowSize": 50,
  "Data": [
    {
      "Id": 19975,
      "GmtCreate": "1624343180000",
      "GmtModified": "1606482979000",
      "UserId": 0,
      "InstanceId": "cas-job-user-***",
      "Name": "job-test",
      "CertType": "upload",
      "ScheduleTime": "1606482979000",
      "StartTime": "1606482979000",
      "EndTime": "1606482979000",
      "Status": "scheduling",
      "Del": 1,
      "Rollback": 1,
      "JobType": "user",
      "CertDomain": "aliyundoc1.com,aliyundoc2.com,aliyundoc3.com",
      "ProductName": "NLB"
    }
  ]
}

Catatan

Jika terjadi kesalahan setelah Anda memanggil operasi OpenAPI Certificate Management Service, gunakan kode kesalahan yang dikembalikan untuk memverifikasi apakah parameter permintaan dan nilainya sudah benar.
Anda dapat mencatat RequestID atau pesan kesalahan SDK yang dikembalikan, lalu menggunakan Alibaba Cloud OpenAPI Diagnostic Platform untuk diagnostik self-service.