前提條件

安裝VS Code。

方式一：在插件市場下載安裝

1. 在VS Code編輯器左側（Activity Bar）導航欄中，單擊圖標。

2. 搜索Alibaba Cloud API Toolkit ，單擊安裝。

方式二：通過瀏覽器下載安裝包

1. 通過瀏覽器訪問官方Marketplace，單擊Install，此時會自動彈出VS Code并跳轉至擴展頁面。

2. 在VS Code的擴展頁面，單擊安裝。

驗證安裝結果

安裝完成后，會在左側（Activity Bar）導航欄顯示阿里云的插件圖標，即表示安裝成功。

阿里云產品訂閱

該插件提供了一鍵訂閱阿里云產品的功能，支持選擇產品不同版本API，并給予推薦版本提示，無需配置文件，可以通過快捷鍵Ctrl+cmd+K（Windows系統中對應的快捷鍵是Ctrl+win+K）搜索和訂閱阿里云產品。

API 搜索

該插件支持搜索已訂閱的API，也可以通過快捷鍵Ctrl+cmd+L（Windows系統中對應的快捷鍵是Ctrl+win+L）搜索并查看已訂閱的API文檔或插入代碼段。

API文檔預覽

點擊API可以打開一個新的標簽頁，并顯示對應的API文檔，文檔包括接口說明、請求參數、響應參數和錯誤碼。

API調試

• 通過身份憑證驗證后，該插件可支持API調試。

• 支持參數表單填寫的方式調試阿里云API，并查看結果。

• 調用返回結果可以直接在編輯器中快速打開。

使用插件提供的代碼示例

補全并運行代碼

• 補全代碼。

  • 修改endpoint。

    登錄OpenAPI 門戶，然后選擇云產品，在云產品主頁可查看支持的服務接入點。

  • 添加請求參數。請求參數請查看API文檔預覽。

  • （可選）添加日志。

  • 保存修改內容。

    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({
                // 請確保代碼運行環境設置了環境變量 ALIBABA_CLOUD_ACCESS_KEY_ID 和 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
                accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
                accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
                // Endpoint 請參考 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);
        }
    }

• 運行代碼

  1. 在終端執行以下命令，將TypeScript編譯成JavaScript文件。

     tsc client.ts # client.ts為文件名

  2. 新建一個main.js文件，在編輯區域復制以下代碼。

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

  3. 在終端（TERMINAL）執行以下命令，運行示例代碼。

     node .\main.js

  4. 運行結果，如果返回結果如下所示，則表示調用成功。