Gunakan Alibaba Cloud SDK untuk Node.js di Visual Studio Code (VS Code) pada Windows.
Prasyarat
-
Node.js telah diinstal. Instal Node.js di Windows.
-
VS Code telah diinstal. Siapkan lingkungan pengembangan Node.js di Windows.
Gunakan SDK
Gunakan proyek contoh dari OpenAPI Portal
Jika OpenAPI Portal gagal mengunduh proyek contoh, coba Gunakan SDK dalam proyek yang sudah ada.
-
Buka halaman API Debugging di OpenAPI Portal. Pilih produk cloud dan API. Contoh ini menggunakan API ECS DescribeRegions. Masukkan DescribeRegions di bilah pencarian dan klik nama API tersebut.

-
Pada tab Parameter Settings, masukkan parameter yang diperlukan. Tab Document di sebelah kanan menyediakan deskripsi API, catatan, informasi penagihan, dan detail parameter.
API DescribeRegions mendukung tiga parameter:
Nama Parameter
Wajib
Deskripsi
InstanceChargeType
Opsional
Wilayah yang didukung bervariasi berdasarkan metode penagihan. Default: PrePaid.
ResourceType
Opsional
Wilayah yang didukung bervariasi berdasarkan jenis resource. Default: instance.
AcceptLanguage
Opsional
Bahasa hasil respons. Default: zh-CN.

-
Pada tab SDK Sample, pilih bahasa dan klik Download Project. Ekstrak proyek yang telah diunduh.

-
Buka VS Code. Di bilah menu, klik File > Open Folder. Pilih folder hasil ekstraksi.
-
Di bilah menu VS Code, klik Terminal > New Terminal.

-
Di Terminal, jalankan perintah berikut untuk menginstal TypeScript.
npm install -g typescript -
Di Terminal, jalankan perintah berikut untuk menginstal dependensi proyek.
npm install -
Di Terminal, jalankan perintah berikut untuk mengompilasi file TypeScript menjadi JavaScript. File hasil kompilasi ditempatkan di direktori
dist.tsc -
Di Terminal, jalankan perintah berikut untuk menjalankan kode contoh.
node ./dist/client.js -
Verifikasi hasilnya. Tekan
Ctrl+Fdi Terminal dan caristatusCode. Respons"statusCode": 200menunjukkan keberhasilan.
Gunakan SDK dalam proyek yang sudah ada
-
Buka VS Code. Klik File > Open Folder dan buat atau pilih folder proyek, misalnya tssdkproject.
-
Di bilah menu VS Code, klik Terminal > New Terminal.

-
Dapatkan SDK.
Buka SDK Center. Pilih produk cloud, seperti ECS. Atur SDK Version ke V2.0 dan Language ke TypeScript.

-
Instal SDK.
Salin perintah instalasi ke Terminal dan tekan Enter untuk menjalankannya.

-
Buat file. Di samping nama proyek, klik ikon New File dan masukkan nama file, misalnya ecsDescribeRegions.js.

-
Inisialisasi client.
Inisialisasi client ECS sebelum memanggil API ECS apa pun.
PentingInisialisasi client memerlukan Pasangan Kunci Akses. Buat AccessKey.
Setelah Anda mendapatkan Pasangan Kunci Akses, konfigurasikan sebagai Variabel lingkungan. Konfigurasikan variabel lingkungan pada sistem Linux, macOS, dan Windows.
Konfigurasi titik akhir: Endpoints.
// Impor client ECS dan client OpenAPI. const ecs20140526 = require('@alicloud/ecs20140526'); const openapiclient = require('@alicloud/openapi-client'); /** * Inisialisasi konfigurasi client ECS. * Konfigurasi ini menggunakan Access Key ID dan Access Key Secret dari variabel lingkungan untuk otentikasi dan menetapkan titik akhir ke ecs.cn-hangzhou.aliyuncs.com. */ const ecsconfig = new openapiclient.Config(); ecsconfig.accessKeyId = process.env.ALIBABA_CLOUD_ACCESS_KEY_ID; // Dapatkan Access Key ID dari variabel lingkungan. ecsconfig.accessKeySecret = process.env.ALIBABA_CLOUD_ACCESS_KEY_SECRET; // Dapatkan Access Key Secret dari variabel lingkungan. ecsconfig.endpoint = 'ecs.cn-hangzhou.aliyuncs.com'; // Tetapkan titik akhir untuk layanan ECS. // Buat instance client untuk API ECS versi 20140526. const ecs20140526client = new ecs20140526.default(ecsconfig); -
Panggil API. Tinjau Dokumentasi API untuk API yang dituju. Contoh berikut memanggil API DescribeRegions dari ECS.
CatatanSetiap API memiliki objek permintaan terpisah yang mengikuti konvensi penamaan ${APIName}${Request}, seperti DescribeRegionsRequest.
// Impor client ECS dan client OpenAPI. const ecs20140526 = require('@alicloud/ecs20140526'); const openapiclient = require('@alicloud/openapi-client'); /** * Inisialisasi konfigurasi client ECS. * Konfigurasi ini menggunakan Access Key ID dan Access Key Secret dari variabel lingkungan untuk otentikasi dan menetapkan titik akhir server ke ecs.cn-hangzhou.aliyuncs.com. */ const ecsconfig = new openapiclient.Config(); ecsconfig.accessKeyId = process.env.ALIBABA_CLOUD_ACCESS_KEY_ID; // Gunakan Access Key ID dari variabel lingkungan. ecsconfig.accessKeySecret = process.env.ALIBABA_CLOUD_ACCESS_KEY_SECRET; // Gunakan Access Key Secret dari variabel lingkungan. ecsconfig.endpoint = 'ecs.cn-hangzhou.aliyuncs.com'; // Tetapkan titik akhir untuk layanan ECS. // Buat instance client untuk API ECS versi 20140526. const ecs20140526client = new ecs20140526.default(ecsconfig); const describeRegionsRequest = new ecs20140526.DescribeRegionsRequest(); // Kirim permintaan untuk mengkueri semua wilayah. ecs20140526client.describeRegions(describeRegionsRequest).then((res)=>{ console.log(res); }) -
Tangani exception.
Node.js V2.0 SDK melemparkan dua jenis exception: exception bisnis (kesalahan layanan) dan exception jaringan (dilemparkan setelah mencapai jumlah maksimum retry). Kode contoh tidak membedakan keduanya karena kelas exception tidak dapat diimpor dari modul eksternal.
// Impor client ECS dan client OpenAPI. const ecs20140526 = require('@alicloud/ecs20140526'); const openapiclient = require('@alicloud/openapi-client'); /** * Inisialisasi konfigurasi client ECS. * Konfigurasi ini menggunakan Access Key ID dan Access Key Secret dari variabel lingkungan untuk otentikasi dan menetapkan titik akhir server ke ecs.cn-hangzhou.aliyuncs.com. */ const ecsconfig = new openapiclient.Config(); ecsconfig.accessKeyId = process.env.ALIBABA_CLOUD_ACCESS_KEY_ID; // Gunakan Access Key ID dari variabel lingkungan. ecsconfig.accessKeySecret = process.env.ALIBABA_CLOUD_ACCESS_KEY_SECRET; // Gunakan Access Key Secret dari variabel lingkungan. ecsconfig.endpoint = 'ecs.cn-hangzhou.aliyuncs.com'; // Tetapkan titik akhir untuk layanan ECS. // Buat instance client untuk API ECS versi 20140526. const ecs20140526client = new ecs20140526.default(ecsconfig); const describeRegionsRequest = new ecs20140526.DescribeRegionsRequest(); // Kirim permintaan untuk mengkueri semua wilayah. ecs20140526client.describeRegions(describeRegionsRequest).then((res) => { console.log(res); }).catch((err) => { console.log(err.message); throw err; }); -
Jalankan kode contoh.
-
Jika Code Runner telah diinstal, klik kanan di editor dan pilih Run Code.

-
Jalankan file dengan perintah node, misalnya,
node .\ecsDescribeRegions.js.
-
Klik Run and Debug di sidebar atau tekan
Ctrl+Shift+D, lalu klik Run and Debug untuk menjalankan file aktif.
-
-
(Opsional) Salin kode contoh dari OpenAPI Portal ke dalam file dan jalankan. Pembuatan kode SDK otomatis.