Alibaba Cloud SDK：整合SDK

1. 登入SDK Center，選擇將要使用產品，例如您將要調用Short Message Service (SMS)的API。

2. 在安裝頁面，所有語言選擇TypeScript。然後在快速入門頁簽中，您可以擷取Short Message Service (SMS)的SDK安裝方式。

特殊情境：檔案上傳 Advance 介面配置

在使用Image Search、視覺智能開放平台等雲產品處理本地圖片或上傳圖片時，官方文檔中提供的OpenAPI介面不支援直接上傳檔案。若需上傳檔案，可以使用雲產品提供的Advance介面，該介面支援傳遞檔案流對象。其底層實現機製為：雲產品會將上傳的檔案臨時儲存於阿里雲OSS上，預設儲存地區為cn-shanghai，並通過讀取該OSS中的臨時檔案來實現相關功能。以阿里雲提供的視覺智能開放平台-人臉人體的DetectBodyCount介面為例：

1. 初始化請求用戶端

   請注意需同時設定regionId和雲產品的endpoint。其中，regionId表示臨時檔案在OSS中所儲存的地區。如果未設定regionId，可能會由於雲產品與OSS所在地區不同，導致在調用OpenAPI時出現逾時等問題。

   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'],
       });
       // endpoint 和 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'],
     });
     // endpoint 和 regionId 需設定為同一地區
     config.regionId = 'cn-shanghai';
     config.endpoint = 'facebody.cn-shanghai.aliyuncs.com';
     return new facebody20191230.default(config);
   }

2. 建立請求對象

   通過建立<OpenAPI名稱>AdvanceRequest請求對象傳遞檔案流，參數名固定為ImageURLObject。

   TypeScript樣本

       // 讀取檔案為fileStream流形式
       const filePath = '<FILE_PATH>';  //需替換檔案路徑
       // 檢查檔案
       if (!fs.existsSync(filePath)) {
           console.error('檔案不存在:', filePath);
           return;
       }
       // 建立流並監聽流錯誤
       const fileStream = fs.createReadStream(filePath).on('error', (err) => {
           console.error('檔案流錯誤:', err);
           process.exit(1);
       });
   
       let detectBodyCountAdvanceRequest = new $facebody20191230.DetectBodyCountAdvanceRequest({
         imageURLObject: fileStream,
       });

   Node.js樣本

       // 讀取檔案為fileStream流形式
       const filePath = '<FILE_PATH>';  //需替換檔案路徑
       // 檢查檔案
       if (!fs.existsSync(filePath)) {
           console.error('檔案不存在:', filePath);
           return;
       }
       // 建立流並監聽流錯誤
       const fileStream = fs.createReadStream(filePath).on('error', (err) => {
           console.error('檔案流錯誤:', err);
           process.exit(1);
       });
   
       let detectBodyCountAdvanceRequest = new facebody20191230.DetectBodyCountAdvanceRequest({
           imageURLObject: fileStream,
       });

3. 發起請求

   需調用函數<介面名稱>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();

        // 讀取檔案為fileStream流形式
        const filePath = '<FILE_PATH>';  //需替換檔案路徑
        // 檢查檔案
        if (!fs.existsSync(filePath)) {
            console.error('檔案不存在:', filePath);
            return;
        }
        // 建立流並監聽流錯誤
        const fileStream = fs.createReadStream(filePath).on('error', (err) => {
            console.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);
                const data = (error as any)?.data?.Recommend;
                if (typeof data === 'string') {
                    console.log('診斷建議:', 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();
    // 讀取檔案為fileStream流形式
    const filePath = '<FILE_PATH>';  //需替換檔案路徑
    // 檢查檔案
    if (!fs.existsSync(filePath)) {
      console.error('檔案不存在:', filePath);
      return;
    }
    // 建立流並監聽流錯誤
    const fileStream = fs.createReadStream(filePath).on('error', (err) => {
      console.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. 調用OpenAPI時報錯，提示“You are not authorized to perform this operation”。

   問題原因及解決方案

   問題原因：您所使用的AccessKey對應的RAM使用者沒有許可權調用該API。

   解決方案：請為該RAM使用者授予相應OpenAPI許可權。關於如何為RAM使用者進行授權，請參見為RAM使用者授權。

   例如，當您在調用SendMessageToGlobe時提示“You are not authorized to perform this operation”，您可以建立如下所示的自訂權限原則，並為該RAM使用者授予相應的許可權。

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

2. 調用OpenAPI時報錯，提示 "triggerUncaughtException Error: getaddrinfo ENOTFOUND"，該錯誤與 'Endpoint' 相關。

   問題原因及解決方案

   問題原因：您所調用的OpenAPI不支援在初始化請求用戶端時填寫的Endpoint。

   解決方案：請查看Endpoint配置，修改Endpoint後重新調用OpenAPI。

3. 調用OpenAPI時報錯，提示：“Cannot read properties of undefined (reading 'getCredential')”或“InvalidAccessKeyId.NotFound: code: 404”，該錯誤與'AccessKey'相關。

   問題原因及解決方案

   問題原因：您的AccessKey未正確傳遞。

   解決方案：在初始化請求用戶端時，檢查是否正確傳遞AccessKey。請注意process.env("XXX")表示從環境變數中擷取XXX的值。

更多SDK使用過程中的報錯問題解決方案，請參見常見問題。