Use Cloud Control API to manage cloud resources in OpenAPI Explorer-Cloud Control API-Alibaba Cloud

Panduan ini menjelaskan cara menggunakan OpenAPI Explorer untuk mengelola sumber daya cloud melalui Cloud Control API. Dengan Virtual Private Cloud (VPC) sebagai contoh, Anda akan mempelajari seluruh siklus hidup operasi—membuat, mengambil, memperbarui, mencantumkan, dan menghapus—pada sebuah resource.

Prasyarat

RAM user: Untuk keamanan, kami menyarankan menggunakan Resource Access Management (RAM) user alih-alih Akun Alibaba Cloud Anda. Untuk informasi lebih lanjut, lihat Create a RAM user.
Izin yang diperlukan: Lampirkan kebijakan berikut ke RAM user Anda:
- Kebijakan sistem AliyunCloudControlAPIFullAccess untuk memberikan akses ke Cloud Control API.
- Kebijakan khusus layanan, seperti AliyunVPCFullAccess, untuk resource yang ingin Anda kelola. Untuk informasi lebih lanjut, lihat Grant permissions to a RAM user.

Memahami Operasi API

Cloud Control API menggunakan operasi standar untuk mengelola resource. Tutorial ini mencakup operasi inti berikut untuk VPC, yang memiliki kode produk VPC dan tipe resource VPC:

CreateResource: Membuat resource baru.
GetResource: Mengambil detail resource tertentu.
UpdateResource: Memodifikasi resource yang sudah ada.
ListResources: Menampilkan daftar semua resource dari tipe tertentu di suatu region.
DeleteResource: Menghapus resource.

Operasi sinkron dan asinkron

Cloud Control API dapat merespons dengan dua cara:

Sinkron (Status 200): Operasi selesai segera, dan badan respons berisi hasilnya.
Asinkron (Status 202): Operasi telah diterima dan akan dijalankan di latar belakang. Respons mengembalikan taskId, yang harus Anda gunakan untuk memanggil operasi GetTask guna memeriksa status akhir task tersebut.

Prosedur

Langkah 1: Buat VPC

Masuk ke OpenAPI Explorer sebagai RAM user Anda dan buka halaman CreateResource untuk VPC. Di bagian parameter, tentukan regionId dan definisikan properti resource di dalam body. Lalu, klik Initiate Call.
Tinjau respons di tab Response.
Jika pemanggilan gagal, klik Diagnose atau gunakan common error codes untuk pemecahan masalah. Anda juga dapat contact us untuk mendapatkan dukungan.
Pemanggilan yang berhasil mengembalikan kode status 200 (operasi sinkron) atau 202 (operasi asinkron). Dari badan respons, salin taskId dan resourceId untuk langkah-langkah berikutnya.
Dalam contoh ini, kode status adalah 202, yang menunjukkan operasi asinkron. Catat taskId dan klik Query task untuk membuka halaman kueri task.

Langkah 2: Periksa status tugas pembuatan

Buka halaman GetTask. Tempelkan taskId dari langkah sebelumnya ke bidang taskId dan klik Initiate Call. Pastikan bahwa status task adalah Succeeded.
Anda juga dapat memverifikasi pembuatan tersebut dengan membuka VPC console.

Langkah 3: Ambil detail VPC

Buka halaman GetResource. Masukkan resourceId yang Anda salin di Langkah 1 dan regionId yang sesuai. Klik Initiate Call untuk mengambil detail VPC baru Anda.

资源查询.png

Langkah 4: Perbarui VPC

Buka halaman UpdateResource. Masukkan resourceId dan regionId. Di dalam body, tentukan properti yang ingin Anda ubah (misalnya, Description). Klik Initiate Call dan verifikasi pembaruan tersebut di VPC console.

资源更新.png

Langkah 5: Cantumkan VPC

Buka halaman GetResources, pilih regionId, lalu klik Initiate Call. Tanggapan yang diterima akan mencantumkan VPC yang Anda buat dalam daftar Sumber daya.

资源列举.png

Langkah 6: Hapus VPC

Untuk membersihkan resource, buka halaman DeleteResource. Masukkan resourceId dan regionId dari VPC yang Anda buat, lalu klik Initiate Call.
Pemanggilan yang berhasil mengembalikan kode status 202 dan taskId baru.
Gunakan kembali operasi GetTask untuk memeriksa status task penghapusan ini. Status Succeeded menegaskan bahwa VPC telah dihapus.

Kode Contoh

Jelajahi contoh kode resmi di GitHub untuk mempelajari lebih lanjut cara menggunakan Cloud Control API secara terprogram: Cloud Control API Demo Repository.