OpenAPI Explorer:Gunakan ekstensi Alibaba Cloud API Toolkit di Visual Studio Code

Prasyarat

Anda harus menginstal VS Code.

Metode 1: Instal dari Marketplace

1. Di Activity Bar di sisi kiri editor VS Code, klik ikon .

2. Cari Alibaba Cloud API Toolkit dan klik Install.

Metode 2: Instal dari browser

1. Buka Marketplace resmi di browser lalu klik Install. VS Code akan otomatis terbuka ke halaman ekstensi tersebut.

2. Di halaman ekstensi dalam VS Code, klik Install.

Verifikasi instalasi

Setelah instalasi selesai, ikon Alibaba Cloud muncul di Activity Bar di sebelah kiri, menandakan bahwa instalasi berhasil.

Tambah atau modifikasi konfigurasi identitas dan kredensial

1. Instal ekstensi Alibaba Cloud CLI Tools.

   1. Buka Alibaba Cloud CLI Tools di browser lalu klik Install.

   2. Pada kotak dialog yang muncul, klik Open.

   3. Di halaman ekstensi dalam VS Code, klik Install.

   4. Setelah instalasi selesai, ikon Alibaba Cloud muncul di status bar.

   Catatan

   Anda juga dapat menginstal command-line interface (CLI) untuk Alibaba Cloud langsung di VS Code. Untuk informasi selengkapnya, lihat Gunakan ekstensi Alibaba Cloud CLI untuk Visual Studio Code.

2. Konfigurasi kredensial identitas.

   1. Di menu bar di bagian atas editor VS Code, pilih Terminal > New Terminal.

   2. Di terminal, jalankan perintah aliyun configure dan ikuti prompt-nya. Anda dapat menggunakan AccessKey yang sudah ada atau membuat yang baru. Untuk informasi selengkapnya, lihat Buat AccessKey. Catatan: Untuk mengurangi risiko kebocoran AccessKey, rahasia AccessKey hanya ditampilkan saat Anda membuatnya dan tidak dapat diambil kembali nanti. Simpanlah di lokasi yang aman.

   3. Tekan Enter setelah setiap baris. Pesan Saving profile[xxx] ...Done. menunjukkan bahwa profil telah disimpan. Jika muncul pesan !!! Configure Failed please configure again !!!, verifikasi gagal karena parameter memiliki format atau nilai yang salah. Namun, profil tetap disimpan secara lokal.

      $ aliyun configure
      Mengonfigurasi profil 'default' ...
      Aliyun Access Key ID [None]: <Your AccessKey ID>
      Aliyun Access Key Secret [None]: <Your AccessKey Secret>
      Default Region Id [None]: cn-hangzhou
      Default output format [json]: json
      Default Language [zh]: zh

      Penting

      Akun Alibaba Cloud memiliki semua izin atas sumber dayanya. Jika AccessKey akun Alibaba Cloud Anda dikompromikan, sumber daya Anda berisiko tinggi. Kami sangat menyarankan agar Anda menggunakan AccessKey Pengguna RAM sebagai gantinya.

Lihat dan ganti identitas pengguna

1. Di status bar di pojok kiri bawah, klik ikon Alibaba Cloud. Pengguna yang telah dikonfigurasi akan ditampilkan di bawah kotak pencarian yang muncul.

2. Klik nama profil untuk mengganti identitas pengguna.

Berlangganan Produk Alibaba Cloud

Ekstensi ini memungkinkan Anda berlangganan Produk Alibaba Cloud dengan sekali klik. Anda dapat memilih versi API yang berbeda dari suatu produk dan menerima rekomendasi versi optimal. Tidak diperlukan file konfigurasi. Gunakan pintasan keyboard Ctrl+Cmd+K (atau Ctrl+Win+K untuk Windows) untuk mencari dan berlangganan Produk Alibaba Cloud.

Pencarian API

Ekstensi ini memungkinkan Anda mencari API yang telah berlangganan. Anda juga dapat menggunakan pintasan keyboard Ctrl+Cmd+L (atau Ctrl+Win+L untuk Windows) untuk mencari API yang telah berlangganan, melihat dokumentasinya, atau menyisipkan potongan kode.

Pratinjau dokumentasi API

Klik API untuk membuka dokumentasinya di tab baru. Dokumentasi mencakup deskripsi API, parameter permintaan, parameter respons, dan kode kesalahan.

Debugging API

• Setelah kredensial identitas Anda diautentikasi, Anda dapat menggunakan ekstensi ini untuk melakukan debugging API.

• Anda dapat melakukan debugging API Alibaba Cloud dengan mengisi formulir parameter dan melihat hasilnya.

• Anda dapat langsung membuka respons di editor.

Gunakan contoh kode dari ekstensi

Lengkapi dan jalankan kode

• Lengkapi kode.

  • Modifikasi titik akhir.

    Login ke OpenAPI Portal, select a cloud product, lalu lihat titik akhir yang didukung di product homepage.

  • Tambahkan parameter permintaan. Untuk informasi tentang parameter permintaan, lihat pratinjau dokumentasi API.

  • (Opsional) Tambahkan log.

  • Simpan perubahan.

    import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
    import Ecs20140526, * as $Ecs20140526 from '@alicloud/ecs20140526';
    export default class DescribeRegion {
        static async main(args: string[]): Promise<void> {
            let config = new $OpenApi.Config({
                // Pastikan variabel lingkungan ALIBABA_CLOUD_ACCESS_KEY_ID dan ALIBABA_CLOUD_ACCESS_KEY_SECRET telah diatur di lingkungan eksekusi kode.
                accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
                accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
                // Untuk informasi lebih lanjut tentang titik akhir, lihat https://api.aliyun.com/product/Ecs.
                endpoint: `ecs.cn-hangzhou.aliyuncs.com`,
            });
            let client = new Ecs20140526(config);
            let describeRegionsRequest = new $Ecs20140526.DescribeRegionsRequest({});
            let response = await client.describeRegions(describeRegionsRequest);
            console.log(response.body?.regions?.region);
        }
    }

• Jalankan kode

  1. Di terminal, jalankan perintah berikut untuk mengompilasi file TypeScript menjadi file JavaScript.

     tsc client.ts # client.ts adalah nama file.

  2. Buat file main.js dan salin kode berikut ke editor.

     const { default: Describeregion } = require("./describeregion");
     
     Describeregion.main();
     

  3. Di terminal, jalankan perintah berikut untuk menjalankan contoh kode.

     node .\main.js

  4. Hasil berikut menunjukkan bahwa pemanggilan berhasil.