Alibaba Cloud SDK:SDK の統合

1. SDK Center にログインし、Short Message Service (SMS) など、呼び出す API の製品を選択します。

2. [Installation] ページ、[All Languages] を [TypeScript] に設定します。 次に、[Quick Start] タブで、Short Message Service (SMS) の SDK インストール手順を確認できます。

Advance 操作によるファイルのアップロード

一部の API (画像検索や Visual Intelligence など) は、ローカルファイルパスを直接受け付けません。 Advance 操作を使用して、ストリーム経由でファイルをアップロードします。 SDK は、ファイルを cn-shanghai リージョンの OSS バケットに一時的に保存し、サービスはそこからファイルを読み取ります。 この例では、Visual Intelligence API の DetectBodyCount 操作を使用します。

1. リクエストクライアントの初期化

   regionId と endpoint の両方を同じリージョンに設定してください。 regionId は、一時的な OSS ファイルが保存される場所を決定します。 regionId を省略すると、製品と OSS バケットのリージョンが一致せず、タイムアウトが発生します。

   TypeScript の例

   function createClient(): facebody20191230 {
       let config = new $OpenApi.Config({
           // 必須。ALIBABA_CLOUD_ACCESS_KEY_ID 環境変数が設定されていることを確認してください。
           accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
           // 必須。ALIBABA_CLOUD_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
           accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
       });
       // エンドポイントと 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({
       // 必須。ALIBABA_CLOUD_ACCESS_KEY_ID 環境変数が設定されていることを確認してください。
       accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
       // 必須。ALIBABA_CLOUD_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
       accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
     });
     // エンドポイントと regionId は同じリージョンである必要があります。
     config.regionId = 'cn-shanghai';
     config.endpoint = 'facebody.cn-shanghai.aliyuncs.com';
     return new facebody20191230.default(config);
   }

2. リクエストオブジェクトの作成

   <OpenAPIName>AdvanceRequest オブジェクトを作成して、ファイルストリームを渡してください。 ファイルストリームのパラメーター名は ImageURLObject です。

   TypeScript の例

       // ファイルをファイルストリームとして読み取ります。
       const filePath = '<FILE_PATH>';  // これを実際のファイルパスに置き換えてください。
       // ファイルが存在するかどうかを確認します。
       if (!fs.existsSync(filePath)) {
           console.error('File does not exist:', filePath);
           return;
       }
       // ストリームを作成し、ストリームエラーをリッスンします。
       const fileStream = fs.createReadStream(filePath).on('error', (err) => {
           console.error('Stream error:', err);
           process.exit(1);
       });
   
       let detectBodyCountAdvanceRequest = new $facebody20191230.DetectBodyCountAdvanceRequest({
         imageURLObject: fileStream,
       });

   Node.js の例

       // ファイルをファイルストリームとして読み取ります。
       const filePath = '<FILE_PATH>';  // これを実際のファイルパスに置き換えてください。
       // ファイルが存在するかどうかを確認します。
       if (!fs.existsSync(filePath)) {
           console.error('File does not exist:', filePath);
           return;
       }
       // ストリームを作成し、ストリームエラーをリッスンします。
       const fileStream = fs.createReadStream(filePath).on('error', (err) => {
           console.error('Stream error:', err);
           process.exit(1);
       });
   
       let detectBodyCountAdvanceRequest = new facebody20191230.DetectBodyCountAdvanceRequest({
           imageURLObject: fileStream,
       });

3. リクエストの送信

   <operationName>Advance 関数を呼び出してリクエストを送信します。

   TypeScript の例

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

   Node.js の例

    // ランタイムパラメーターを設定します。
    let runtime = new Util.RuntimeOptions({ });
    let client = Client.createClient();
    // リクエストを送信します。
    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({
            // 必須。ALIBABA_CLOUD_ACCESS_KEY_ID 環境変数が設定されていることを確認してください。
            accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
            // 必須。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();

        // ファイルをファイルストリームとして読み取ります。
        const filePath = '<FILE_PATH>';  // これを実際のファイルパスに置き換えてください。
        // ファイルが存在するかどうかを確認します。
        if (!fs.existsSync(filePath)) {
            console.error('File does not exist:', filePath);
            return;
        }
        // ストリームを作成し、ストリームエラーをリッスンします。
        const fileStream = fs.createReadStream(filePath).on('error', (err) => {
            console.error('Stream error:', err);
            process.exit(1);
        });

        let detectBodyCountAdvanceRequest = new $facebody20191230.DetectBodyCountAdvanceRequest({
            imageURLObject: fileStream,
        });
        let runtime = new $Util.RuntimeOptions({});
        try {
            // リクエストを送信します。
            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('Diagnostic 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({
      // 必須。ALIBABA_CLOUD_ACCESS_KEY_ID 環境変数が設定されていることを確認してください。
      accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
      // 必須。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();
    // ファイルをファイルストリームとして読み取ります。
    const filePath = '<FILE_PATH>';  // これを実際のファイルパスに置き換えてください。
    // ファイルが存在するかどうかを確認します。
    if (!fs.existsSync(filePath)) {
      console.error('File does not exist:', filePath);
      return;
    }
    // ストリームを作成し、ストリームエラーをリッスンします。
    const fileStream = fs.createReadStream(filePath).on('error', (err) => {
      console.error('Stream error:', err);
      process.exit(1);
    });
    // リクエストパラメーターを設定します。
    let detectBodyCountAdvanceRequest = new facebody20191230.DetectBodyCountAdvanceRequest({
      imageURLObject: fileStream,
    });
    let runtime = new Util.RuntimeOptions({});
    try {
      // リクエストを送信します。
      const res = await client.detectBodyCountAdvance(detectBodyCountAdvanceRequest, runtime);
      console.log(res);
    } catch (error) {
      // これはデモンストレーションのみを目的としています。 例外は慎重に処理してください。 プロジェクトで例外を無視しないでください。
      console.log(error);
    }
  }
}

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

よくある質問

1. API 呼び出し時の "You are not authorized to perform this operation" エラー

   原因と解決策

   原因： AccessKey に関連付けられている RAM ユーザーに、API を呼び出すために必要な権限がありません。

   解決策： RAM ユーザーに必要な API 権限を付与してください。 「RAM ユーザー権限の管理」をご参照ください。

   たとえば、 または SendMessageToGlobe を呼び出すときにこのエラーが発生した場合は、次のカスタム権限ポリシーを作成して RAM ユーザーにアタッチできます。

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

2. "triggerUncaughtException Error: getaddrinfo ENOTFOUND" エラー (エンドポイントの問題)

   原因と解決策

   原因： 指定されたエンドポイントは、呼び出している OpenAPI オペレーションでサポートされていません。

   解決策： 「エンドポイントの設定」を使用してエンドポイントを修正し、再試行してください。

3. "Cannot read properties of undefined (reading 'getCredential')" または "InvalidAccessKeyId.NotFound: code: 404" エラー

   原因と解決策

   原因： AccessKey が正しく渡されませんでした。

   解決策： クライアントの初期化中に AccessKey が正しく渡されていることを確認してください。 process.env("XXX") は、環境変数から XXX の値を読み取ります。

その他の一般的なエラーについては、「よくある質問」をご参照ください。