OpenAPI Explorer:Gunakan Alibaba Cloud API Toolkit di VS Code

Prasyarat

VS Code telah diinstal.

Metode 1: Instal dari tampilan Extensions

1. Pada Activity Bar VS Code, klik ikon .

2. Cari Alibaba Cloud API Toolkit lalu klik Install.

Metode 2: Instal dari VS Code Marketplace

1. Kunjungi halaman Alibaba Cloud API Toolkit di VS Code Marketplace lalu klik Install. VS Code akan terbuka pada halaman ekstensi tersebut.

2. Klik Install pada halaman ekstensi di VS Code.

Verifikasi instalasi

Setelah instalasi, ikon Alibaba Cloud muncul di Activity Bar.

Pada Extensions view di sidebar VS Code, cari Alibaba Cloud API Toolkit. Panel utama menampilkan nama ekstensi, versi (v0.0.9), penerbit (Alibaba Cloud OpenAPI), dan tombol biru Uninstall. Hal ini menandakan bahwa ekstensi telah terinstal.

Berlangganan layanan

Berlangganan layanan Alibaba Cloud dan pilih versi API. Ekstensi ini merekomendasikan versi dan tidak memerlukan file konfigurasi. Tekan Ctrl+Cmd+K (Ctrl+Win+K di Windows) untuk mencari dan berlangganan.

Pada daftar drop-down layanan API, gunakan kotak pencarian untuk memfilter dan memilih layanan target. Misalnya, pilih Certificate Management Service (kode layanan cas, versi yang direkomendasikan 2020-04-07).

Pencarian API

Cari API yang telah Anda langganan dan lihat referensinya. Tekan Ctrl+Cmd+L (Ctrl+Win+L di Windows) untuk mencari API atau menyisipkan potongan kode.

Setelah Anda memasukkan kata kunci seperti describe di kotak pencarian, operasi API yang cocok muncul di bawah kotak tersebut. Setiap entri menampilkan metode permintaan, nama operasi, deskripsi singkat, dan path versi.

Pratinjau referensi API

Klik operasi API untuk melihat referensinya di tab baru, termasuk catatan penggunaan, parameter permintaan, parameter respons, dan kode kesalahan.

Di API Toolkit, panel kiri menampilkan pohon navigasi API, tempat Anda dapat menjelajahi operasi API berdasarkan layanan dan kategori. Setelah memilih operasi, misalnya RebootInstances — Restarts one or more instances, panel utama di kanan menampilkan referensi operasi tersebut, termasuk deskripsi dan parameter permintaan. Gunakan tab di bagian atas untuk beralih antara Document, Debug, dan Code Sample.

Debugging API

• Lakukan debugging operasi API setelah verifikasi kredensial.

• Konfigurasikan parameter dan lihat hasil debugging.

• Lihat respons API langsung di VS Code.

Sebagai contoh, pilih operasi DescribeRegions. Pada formulir parameter, atur Endpoint ke China (Hangzhou), InstanceChargeType ke PrePaid, ResourceType ke instance, dan AcceptLanguage ke zh-CN. Setelah Anda klik Debug, panel kanan menampilkan respons sukses dengan kode status HTTP 200 dalam format JSON yang berisi daftar wilayah yang tersedia.

Gunakan kode contoh

Lengkapi dan jalankan kode

• Lengkapi kode

  • Ubah endpoint.

    Masuk ke OpenAPI Explorer, arahkan kursor ke Cloud Products lalu pilih layanan. Lihat endpoint yang didukung di tab Regions.

  • Tentukan parameter permintaan. Untuk informasi selengkapnya, lihat bagian pratinjau referensi API topik ini.

  • Opsional. Tambahkan logging.

  • Simpan kode.

    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 dikonfigurasi di lingkungan runtime kode. 
                accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
                accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
                // Tentukan endpoint. Untuk informasi selengkapnya, lihat endpoint di https://api.alibabacloud.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. Kompilasi file TypeScript menjadi JavaScript:

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

  2. Buat file main.js dengan kode berikut:

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

  3. Jalankan kode contoh:

     node .\main.js

  4. Jika hasil berikut dikembalikan, pemanggilan berhasil.

     PS D:\ide\tooldemo> tsc describeregion.ts
     PS D:\ide\tooldemo> node .\main.js
     [
       DescribeRegionsResponseBodyRegionsRegion {
         localName: 'China (Qingdao)',
         regionEndpoint: 'ecs.cn-qingdao.aliyuncs.com',
         regionId: 'cn-qingdao'
       },
       DescribeRegionsResponseBodyRegionsRegion {
         localName: 'China (Beijing)',
         regionEndpoint: 'ecs.cn-beijing.aliyuncs.com',
         regionId: 'cn-beijing'
       },
       DescribeRegionsResponseBodyRegionsRegion {
         localName: 'China (Zhangjiakou)',
         regionEndpoint: 'ecs.cn-zhangjiakou.aliyuncs.com',
         regionId: 'cn-zhangjiakou'
       },
       DescribeRegionsResponseBodyRegionsRegion {
         localName: 'China (Hohhot)',
         regionEndpoint: 'ecs.cn-huhehaote.aliyuncs.com',
         regionId: 'cn-huhehaote'
       },
       DescribeRegionsResponseBodyRegionsRegion {
         localName: 'China (Ulanqab)',
         regionEndpoint: 'ecs.cn-wulanchabu.aliyuncs.com',
         regionId: 'cn-wulanchabu'
       },
       DescribeRegionsResponseBodyRegionsRegion {
         localName: 'China (Hangzhou)',
         ...
       }
     ]