OpenAPI Explorer:Visual Studio Code での Alibaba Cloud API Toolkit 拡張機能の使用

前提条件

VS Code をインストールしておく必要があります。

方法 1：Marketplace からのインストール

1. VS Code エディターの左側にあるアクティビティバーで、 アイコンをクリックします。

2. Alibaba Cloud API Toolkit を検索し、[インストール] をクリックします。

方法 2：ブラウザからのインストール

1. ブラウザで公式の Marketplace にアクセスし、[インストール] をクリックします。VS Code が自動的に開き、拡張機能のページが表示されます。

2. VS Code の拡張機能ページで、[インストール] をクリックします。

インストールの確認

インストールが完了すると、左側のアクティビティバーに Alibaba Cloud のアイコンが表示されます。これは、インストールが成功したことを示します。

ID と認証情報の構成を追加または変更する

1. Alibaba Cloud CLI Tools 拡張機能をインストールします。

   1. ブラウザで Alibaba Cloud CLI Tools にアクセスし、[インストール] をクリックします。

   2. 表示されるダイアログボックスで、[開く] をクリックします。

   3. VS Code の拡張機能ページで、[インストール] をクリックします。

   4. インストールが完了すると、ステータスバーに Alibaba Cloud のアイコンが表示されます。

   説明

   VS Code で Alibaba Cloud のコマンドラインインターフェイス (CLI) を直接インストールすることもできます。詳細については、「Visual Studio Code 向け Alibaba Cloud CLI 拡張機能の使用」をご参照ください。

2. 認証情報を設定します。

   1. VS Code エディター上部のメニューバーで、[ターミナル] > [新しいターミナル] を選択します。

   2. ターミナルで aliyun configure コマンドを実行し、プロンプトに従います。既存の AccessKey を使用するか、新しい AccessKey を作成できます。詳細については、AccessKey の作成をご参照ください。注： AccessKey の漏洩リスクを軽減するため、AccessKey Secret は作成時にのみ表示され、後から取得することはできません。安全な場所に保管する必要があります。

   3. 各行を入力した後、Enter キーを押します。「Saving profile[xxx] ...Done.」というメッセージが表示されたら、プロファイルが保存されたことを示します。「!!! Configure Failed please configure again !!!」というメッセージが表示された場合、パラメーターのフォーマットまたは値が正しくないため検証に失敗しましたが、プロファイルはローカルに保存されています。

      $ aliyun configure
      プロファイル 'default' を設定しています...
      Aliyun AccessKey ID [なし]: <お使いの AccessKey ID>
      Aliyun AccessKey Secret [なし]: <お使いの AccessKey Secret>
      デフォルトのリージョン ID [なし]: cn-hangzhou
      デフォルトの出力フォーマット [json]: json
      デフォルトの言語 [zh]: zh

      重要

      Alibaba Cloud アカウントはそのリソースに対するすべての権限を持っています。Alibaba Cloud アカウントの AccessKey が漏洩すると、リソースは高いリスクにさらされます。代わりに RAM ユーザーの AccessKey を使用することを強く推奨します。

ユーザー ID の表示と切り替え

1. 左下のステータスバーで、Alibaba Cloud のアイコンをクリックします。表示される検索ボックスの下に、設定済みのユーザーが表示されます。

2. プロファイル名をクリックして、ユーザー ID を切り替えます。

Alibaba Cloud プロダクトのサブスクライブ

この拡張機能では、ワンクリックで Alibaba Cloud プロダクトにサブスクライブできるほか、プロダクトのさまざまな API バージョンを選択して最適なバージョンの推奨を受け取ることもできます。構成ファイルは不要です。キーボードショートカット Ctrl+Cmd+K (Windows の場合は Ctrl+Win+K) を使用して、Alibaba Cloud プロダクトを検索し、サブスクライブすることもできます。

API 検索

この拡張機能では、サブスクライブした API を検索できます。また、キーボードショートカット Ctrl+Cmd+L (Windows の場合は Ctrl+Win+L) を使用して、サブスクライブした API の検索、そのドキュメントの表示、またはコードスニペットの挿入ができます。

API ドキュメントのプレビュー

API をクリックすると、新しいタブでそのドキュメントが開きます。ドキュメントには、API の説明、リクエストパラメーター、レスポンスパラメーター、エラーコードが含まれています。

API デバッグ

• 認証情報が認証された後、この拡張機能を使用して API をデバッグできます。

• パラメーターフォームに入力し、結果を確認することで、Alibaba Cloud API をデバッグできます。

• 応答をエディターで直接開くことができます。

拡張機能のコード例の使用

コードを完成させて実行する

• コードを補完します。

  • エンドポイントを変更します。

    OpenAPI Portal にログインし、[クラウドプロダクトを選択] し、[プロダクトホームページ] でサポートされているエンドポイントを表示します。

  • リクエストパラメーターを追加します。リクエストパラメーターについては、「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'],
                // エンドポイントの詳細については、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. ターミナルで、次のコマンドを実行してサンプルコードを実行します。

     node .\main.js

  4. 次の結果は、呼び出しが成功したことを示します。