Alibaba Cloud SDK:Alibaba Cloud SDK V2.0 for Node.js を統合する

1. SDK Center にログインし、SDK を使用したいサービスを選択します。この例では、Short Message Service (SMS) を選択します。

2. [Short Message Service] ページ、[TypeScript] を [すべての言語] セクションで選択します。 [クイックスタート] タブで、Short Message Service (SMS) SDK のインストール方法を取得します。

特別なシナリオ: Advance オペレーションによるファイルアップロード

オンプレミス機器の画像を処理したり、画像をアップロードしたりするために Image Search または Visual Intelligence API (VIAPI) を使用する場合、ドキュメントに記載されている Image Search または VIAPI の API は直接アップロードをサポートしていません。画像をアップロードするには、ファイルストリームの送信をサポートする Advance オペレーションを使用する必要があります。クラウドサービスは、アップロードされたファイルを一時的に Object Storage Service (OSS) に保存し、必要に応じて OSS から一時ファイルを読み取ります。 OSS のデフォルトリージョンは cn-shanghai です。次の例は、VIAPI の DetectBodyCount オペレーションを呼び出す方法を示しています。

1. リクエストクライアントを初期化する

   regionId パラメータとクラウドサービスの endpoint の両方が指定されていることを確認します。 regionId は、一時ファイルが保存される OSS リージョンを示します。 regionId パラメータを構成しない場合、クラウドサービスは OSS とは異なるリージョンを使用する可能性があり、API タイムアウトが発生する可能性があります。

   TypeScript

   function createClient(): facebody20191230 {
       let config = new $OpenApi.Config({
           // Required. Make sure that the following environment variable is set in the code runtime environment: ALIBABA_CLOUD_ACCESS_KEY_ID. 
           accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
           // Required. Make sure that the following environment variable is set in the code runtime environment: ALIBABA_CLOUD_ACCESS_KEY_SECRET. 
           accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
       });
       // Specify the same region for the endpoint and regionId parameters.
       // エンドポイントと regionId パラメータに同じリージョンを指定します。
       config.regionId = 'cn-shanghai';
       config.endpoint = 'facebody.cn-shanghai.aliyuncs.com';
       return new facebody20191230(config);
   }

   Node.js

   function createClient() {
     let config = new OpenApi.Config({
       // Required. Make sure that the following environment variable is set in the code runtime environment: ALIBABA_CLOUD_ACCESS_KEY_ID. 
       accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
       // Required. Make sure that the following environment variable is set in the code runtime environment: ALIBABA_CLOUD_ACCESS_KEY_SECRET. 
       accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
     });
     // Specify the same region for the endpoint and regionId parameters.
     // エンドポイントと regionId パラメータに同じリージョンを指定します。
     config.regionId = 'cn-shanghai';
     config.endpoint = 'facebody.cn-shanghai.aliyuncs.com';
     return new facebody20191230.default(config);
   }

2. リクエストオブジェクトを作成する

   <API オペレーション>AdvanceRequest リクエストオブジェクトを作成して、ファイルストリームを渡します。リクエストオブジェクトで、パラメータ名を ImageURLObject に設定します。

   TypeScript

       // Read the file as a fileStream stream.
       // ファイルを fileStream ストリームとして読み取ります。
       const filePath = '<FILE_PATH>';  // Replace the value with the actual file path.
       // 実際のファイルパスで値を置き換えます。
       // Check the file.
       // ファイルを確認します。
       if (!fs.existsSync(filePath)) {
           console.error('The file does not exist:', filePath);
           return;
       }
       // Create a stream and listen for stream errors.
       // ストリームを作成し、ストリームエラーをリッスンします。
       const fileStream = fs.createReadStream(filePath).on('error', (err) => {
           console.error('File stream errors:', err);
           process.exit(1);
       });
   
       let detectBodyCountAdvanceRequest = new $facebody20191230.DetectBodyCountAdvanceRequest({
         imageURLObject: fileStream,
       });

   Node.js

       // Read the file as a fileStream stream.
       // ファイルを fileStream ストリームとして読み取ります。
       const filePath = '<FILE_PATH>';  // Replace the value with the actual file path.
       // 実際のファイルパスで値を置き換えます。
       // Check the file.
       // ファイルを確認します。
       if (!fs.existsSync(filePath)) {
           console.error('The file does not exist:', filePath);
           return;
       }
       // Create a stream and listen for stream errors.
       // ストリームを作成し、ストリームエラーをリッスンします。
       const fileStream = fs.createReadStream(filePath).on('error', (err) => {
           console.error('File stream errors:', err);
           process.exit(1);
       });
   
       let detectBodyCountAdvanceRequest = new facebody20191230.DetectBodyCountAdvanceRequest({
           imageURLObject: fileStream,
       });

3. リクエストを開始する

   <API オペレーション>AdvanceRequest オペレーションを呼び出します。

   TypeScript

   // Configure the runtime parameters.
   // ランタイムパラメータを構成します。
   let runtime = new $Util.RuntimeOptions({ });
   let client = Client.createClient();
   // Send the request.   
   // リクエストを送信します。
   await client.detectBodyCountAdvance(detectBodyCountAdvanceRequest, runtime);

   Node.js

    // Configure the runtime parameters.
    // ランタイムパラメータを構成します。
    let runtime = new Util.RuntimeOptions({ });
    let client = Client.createClient();
    // Send the request.   
    // リクエストを送信します。
    await client.detectBodyCountAdvance(detectBodyCountAdvanceRequest, runtime);  

import { default as facebody20191230 } from '@alicloud/facebody20191230';
import * as $facebody20191230 from '@alicloud/facebody20191230';
import * as $OpenApi from '@alicloud/openapi-client';
import * as $Util from '@alicloud/tea-util';
import * as fs from "fs";

export default class Client {
    static createClient(): facebody20191230 {
        let config = new $OpenApi.Config({
            // Required. Make sure that the following environment variable is set in the code runtime environment: ALIBABA_CLOUD_ACCESS_KEY_ID. 
            accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
            // Required. Make sure that the following environment variable is set in the code runtime environment: ALIBABA_CLOUD_ACCESS_KEY_SECRET. 
            accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
        });
        config.regionId = 'cn-shanghai';
        config.endpoint = 'facebody.cn-shanghai.aliyuncs.com';
        return new facebody20191230(config);
    }

    static async main(): Promise<void> {
        let client = Client.createClient();

        // Read the file as a fileStream stream.
        // ファイルを fileStream ストリームとして読み取ります。
        const filePath = '<FILE_PATH>';  // Replace the value with the actual file path.
        // 実際のファイルパスで値を置き換えます。
        // Check the file.
        // ファイルを確認します。
        if (!fs.existsSync(filePath)) {
            console.error('The file does not exist:', filePath);
            return;
        }
        // Create a stream and listen for stream errors.
        // ストリームを作成し、ストリームエラーをリッスンします。
        const fileStream = fs.createReadStream(filePath).on('error', (err) => {
            console.error('File stream errors:', err);
            process.exit(1);
        });

        let detectBodyCountAdvanceRequest = new $facebody20191230.DetectBodyCountAdvanceRequest({
            imageURLObject: fileStream,
        });
        let runtime = new $Util.RuntimeOptions({});
        try {
            // Send the request.
            // リクエストを送信します。
            const res = await client.detectBodyCountAdvance(detectBodyCountAdvanceRequest, runtime);
            console.log(res);
        } catch (error) {
            if (error instanceof Error) {
                console.error('Error message:', error.message);
                const data = (error as any)?.data?.Recommend;
                if (typeof data === 'string') {
                    console.log('Suggestion:', data);
                }
            }
        }
    }
}

Client.main();

'use strict';
const facebody20191230 = require('@alicloud/facebody20191230');
const OpenApi = require('@alicloud/openapi-client');
const Util = require('@alicloud/tea-util');
const fs = require('fs');

class Client {
  static createClient() {
    let config = new OpenApi.Config({
      // Required. Make sure that the following environment variable is set in the code runtime environment: ALIBABA_CLOUD_ACCESS_KEY_ID. 
      accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
      // Required. Make sure that the following environment variable is set in the code runtime environment: ALIBABA_CLOUD_ACCESS_KEY_SECRET. 
      accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
    });
    config.regionId = 'cn-shanghai';
    config.endpoint = 'facebody.cn-shanghai.aliyuncs.com';
    return new facebody20191230.default(config);
  }

  static async main() {
    let client = Client.createClient();
    // Read the file as a fileStream stream.
    // ファイルを fileStream ストリームとして読み取ります。
    const filePath = '<FILE_PATH>';  // Replace the value with the actual file path.
    // 実際のファイルパスで値を置き換えます。
    // Check the file.
    // ファイルを確認します。
    if (!fs.existsSync(filePath)) {
      console.error('The file does not exist:', filePath);
      return;
    }
    // Create a stream and listen for stream errors.
    // ストリームを作成し、ストリームエラーをリッスンします。
    const fileStream = fs.createReadStream(filePath).on('error', (err) => {
      console.error('File stream errors:', err);
      process.exit(1);
    });
    // Configure request parameters.
    // リクエストパラメータを構成します。
    let detectBodyCountAdvanceRequest = new facebody20191230.DetectBodyCountAdvanceRequest({
      imageURLObject: fileStream,
    });
    let runtime = new Util.RuntimeOptions({});
    try {
      // Send the request.
      // リクエストを送信します。
      const res = await client.detectBodyCountAdvance(detectBodyCountAdvanceRequest, runtime);
      console.log(res);
    } catch (error) {
      // Handle exceptions with caution based on your actual business scenario and do not ignore exceptions in your project. The error messages displayed in this example are for reference only. 
      // 実際のビジネスシナリオに基づいて例外を慎重に処理し、プロジェクトで例外を無視しないでください。この例に表示されるエラーメッセージは参照用です。
      console.log(error);
    }
  }
}

exports.Client = Client;
Client.main();

FAQ

1. API オペレーションによってスローされた「You are not authorized to perform this operation」エラーを処理するにはどうすればよいですか？

   考えられる原因と解決策

   考えられる原因: Resource Access Management (RAM) ユーザーの AccessKey ペアに、API オペレーションを呼び出す権限がありません。

   解決策: RAM ユーザーに必要な権限を付与します。詳細については、「RAM ユーザーに権限を付与する」をご参照ください。

   たとえば、SendMessageToGlobe API オペレーションによって「You are not authorized to perform this operation」エラーがスローされた場合は、次のカスタムポリシーを作成して、必要な権限を RAM ユーザーに付与します。

   {
     "Version": "1",
     "Statement": [
       {
         "Effect": "Allow",
         "Action": "dysms:SendMessageToGlobe",
         "Resource": "*"
       }
     ]
   }

2. API オペレーションによってスローされた「triggerUncaughtException Error: getaddrinfo ENOTFOUND」エンドポイントエラーを処理するにはどうすればよいですか？

   考えられる原因と解決策

   考えられる原因: リクエストクライアントを初期化するときに指定したエンドポイントは、API オペレーションでサポートされていません。

   解決策: サポートされているエンドポイントを指定して、再試行します。詳細については、「エンドポイントを構成する」をご参照ください。

3. API オペレーションによってスローされた「Cannot read properties of undefined (reading 'getCredential')」または「InvalidAccessKeyId.NotFound: code: 404」AccessKey エラーを処理するにはどうすればよいですか？

   考えられる原因と解決策

   考えられる原因: AccessKey ペアがリクエストに正しく渡されていません。

   解決策: リクエストクライアントを初期化するときに、AccessKey ペアが正しく渡されていることを確認します。 process.env("XXX") の XXX 値は、環境変数から取得されます。

SDK 例外を処理する方法の詳細については、「FAQ」をご参照ください。