Image Search：Node.js SDK

介面列表

準備工作

• 在安裝和使用阿里雲SDK前，確保您已經註冊阿里雲帳號並產生存取金鑰（AccessKey）。詳情請參見建立AccessKey。

• 安裝Image SearchNode.js SDK。

npm install @alicloud/imagesearch20201214@4.0.0 --save

Add介面

• 程式碼範例

  const oss = require('@alicloud/oss-util');
  const fs = require('fs');
  const imagesearch = require('@alicloud/imagesearch20201214')
  // 建立AK/SK參考：https://www.alibabacloud.com/help/zh/resource-access-management/latest/accesskey-pairs-create-an-accesskey-pair-for-a-ram-user
  const client = new imagesearch.default({
    // 阿里雲帳號AccessKey擁有所有API的存取權限，建議您使用RAM使用者進行API訪問或日常營運。
    // 強烈建議不要把AccessKey ID和AccessKey Secret儲存到工程代碼裡，否則可能導致AccessKey泄露，威脅您帳號下所有資源的安全。
    // 本樣本以將AccessKey ID和AccessKey Secret儲存在環境變數為例說明。您也可以根據業務需要，儲存到設定檔裡。
    accessKeyId: process.env.CC_AK_ENV,
    accessKeySecret: process.env.CC_SK_ENV,
    type: "access_key",
    // 請更換成您購買執行個體的地區，例如購買的是杭州地區，則endpoint="imagesearch.cn-hangzhou.aliyuncs.com"
    endpoint: "imagesearch.cn-shanghai.aliyuncs.com",
  
    // 以下為內網（VPC）訪問方式
    // 說明：內網（VPC）訪問：僅限同地區ECS或資源的訪問，例如您購買的Image Search執行個體是華東2（上海），那麼您的ECS或資源也必須在華東2（上海）才能通過內網VPC地址訪問圖搜服務，否則會調用不通，如果遇到調用不通，請先檢查您的ECS或資源與Image Search是否在同一個地區。
    // endpointType : "internal",  // 如果是內網訪問Image Search服務，則endpointType為必填項，值統一為"internal"
    // endpoint : "imagesearch-vpc.cn-shanghai.aliyuncs.com", // 為內網訪問（VPC）地址，請您更換為您購買執行個體的地區，例如您購買執行個體的地區為杭州，則endpoint="imagesearch-vpc.cn-hangzhou.aliyuncs.com"
  
    // 請您更換成您購買執行個體的地區，例如您購買的執行個體地區為杭州，則更換為regionId="cn-hangzhou"
    regionId: "cn-shanghai",
    protocol: 'http'});
  var picContent = fs.createReadStream("D:/123.jpg");
  async function demo() {
    const addImageAdvanceRequest = new imagesearch.AddImageAdvanceRequest({
      // 必填，Image Search執行個體名稱。注意是執行個體名稱不是執行個體ID。購買後通過上雲層管控台執行個體資訊一欄查看：https://imagesearch.console.aliyun.com/overview
      instanceName: "XXXXXXXXXX",
       // 必填，商品id，最多支援 512個字元。
       // 一個商品可有多張圖片。
      productId: "123455",
      // 必填，圖片名稱，最多支援 512個字元。
      // 1. ProductId + PicName唯一確定一張圖片。
      // 2. 如果多次添加圖片具有相同的ProductId + PicName，以最後一次添加為準，前面添加的圖片將被覆蓋。
      picName: "this",
      // 圖片內容，最多支援 4MB大小圖片以及5s的傳輸等待時間。當前僅支援PNG、JPG、JPEG、BMP、GIF、WEBP、TIFF、PPM格式圖片；        
      // 對於商品、商標、通用圖片搜尋，圖片長和寬的像素必須都大於等於100且小於等於4096；        
      // 對於布料搜尋，圖片長和寬的像素必須都大於等於448且小於等於4096；        
      // 映像中不能帶有旋轉資訊
      picContentObject: picContent,
      // 選填，圖片類目。
      // 1. 對於商品搜尋：若設定類目，則以設定的為準；若不設定類目，將由系統進行類目預測，預測的類目結果可在Response中擷取 。
      // 2. 對於布料、商標、通用搜尋：不論是否設定類目，系統會將類目設定為88888888。
      categoryId : 3,
      // 選填，使用者自訂的內容，最多支援4096個字元。
      // 查詢時會返回該欄位。例如可添加圖片的描述等文本。
      customContent : "this is a simple test",
      // 選填，整數類型屬性，可用於查詢時過濾，查詢時會返回該欄位。
      //  例如不同的網站的圖片/不同使用者的圖片，可以設定不同的IntAttr，查詢時通過過濾來達到隔離的目的
      intAttr : 56,
      // 選填，字串類型屬性，最多支援 128個字元。可用於查詢時過濾，查詢時會返回該欄位。
      strAttr : "test",
      // 選填，是否需要進行主體識別，預設為true。
      // 1.為true時，由系統進行主體識別，以識別的主體進行搜尋，主體識別結果可在Response中擷取。
      // 2. 為false時，則不進行主體識別，以整張圖進行搜尋。
      // 3.對於布料圖片搜尋，此參數會被忽略，系統會以整張圖進行搜尋。
      crop : true,
      // 選填，圖片的主體地區，格式為 x1,x2,y1,y2, 其中 x1,y1 是左上方的點，x2，y2是右下角的點。設定的region 地區不要超過圖片的邊界。
      // 若使用者佈建了Region，則不論Crop參數為何值，都將以使用者輸入Region進行搜尋。
      // 對於布料圖片搜尋，此參數會被忽略，系統會以整張圖進行搜尋。
      region : "167,467,221,407"
    });
    let ossRuntime = new oss.RuntimeOptions({});
    const addResponse = await client.addImageAdvance(addImageAdvanceRequest, ossRuntime);
    console.log(1, addResponse);
  }
  demo();

• 結果樣本

  AddImageResponse {
    requestId: 'B85D5B4A-92AF-44C1-A3FB-9B554950F8D1',
    success: true,
    message: 'success',
    code: 0,
    picInfo: AddImageResponsePicInfo { categoryId: 0, region: '167,477,221,407' }
  }

SearchImageByPic介面

• 程式碼範例

  const oss = require('@alicloud/oss-util');
  const fs = require('fs');
  const imagesearch = require('@alicloud/imagesearch20201214')
  // 建立AK/SK參考：https://www.alibabacloud.com/help/zh/resource-access-management/latest/accesskey-pairs-create-an-accesskey-pair-for-a-ram-user
  const client = new imagesearch.default({
    // 阿里雲帳號AccessKey擁有所有API的存取權限，建議您使用RAM使用者進行API訪問或日常營運。
    // 強烈建議不要把AccessKey ID和AccessKey Secret儲存到工程代碼裡，否則可能導致AccessKey泄露，威脅您帳號下所有資源的安全。
    // 本樣本以將AccessKey ID和AccessKey Secret儲存在環境變數為例說明。您也可以根據業務需要，儲存到設定檔裡。
    accessKeyId: process.env.CC_AK_ENV,
    accessKeySecret: process.env.CC_SK_ENV,
    type: "access_key",
    // 請更換成您購買執行個體的地區，例如購買的是杭州地區，則endpoint="imagesearch.cn-hangzhou.aliyuncs.com"
    endpoint: "imagesearch.cn-shanghai.aliyuncs.com",
  
    // 以下為內網（VPC）訪問方式
    // 說明：內網（VPC）訪問：僅限同地區ECS或資源的訪問，例如您購買的Image Search執行個體是華東2（上海），那麼您的ECS或資源也必須在華東2（上海）才能通過內網VPC地址訪問圖搜服務，否則會調用不通，如果遇到調用不通，請先檢查您的ECS或資源與Image Search是否在同一個地區。
    // endpointType : "internal",  // 如果是內網訪問Image Search服務，則endpointType為必填項，值統一為"internal"
    // endpoint : "imagesearch-vpc.cn-shanghai.aliyuncs.com", // 為內網訪問（VPC）地址，請您更換為您購買執行個體的地區，例如您購買執行個體的地區為杭州，則endpoint="imagesearch-vpc.cn-hangzhou.aliyuncs.com"
  
    // 請您更換成您購買執行個體的地區，例如您購買的執行個體地區為杭州，則更換為regionId="cn-hangzhou"
    regionId: "cn-shanghai",
    protocol: 'http'
  });
  var picContent = fs.createReadStream("D:/123.jpg");
  async function demo() {
    const searchImageByPicAdvanceRequest = new imagesearch.SearchImageByPicAdvanceRequest({
      // 必填，Image Search執行個體名稱。注意是執行個體名稱不是執行個體ID。購買後通過上雲層管控台執行個體資訊一欄查看：https://imagesearch.console.aliyun.com/overview
      instanceName: "XXXXXXXX",
      //圖片內容，最多支援 4MB大小圖片以及5s的傳輸等待時間。當前僅支援PNG、JPG、JPEG、BMP、GIF、WEBP、TIFF、PPM格式圖片；        
      // 對於商品、商標、通用圖片搜尋，圖片長和寬的像素必須都大於等於100且小於等於4096；        
      // 對於布料搜尋，圖片長和寬的像素必須都大於等於448且小於等於4096；        
      // 映像中不能帶有旋轉資訊
      picContentObject: picContent,
      // 選填，商品類目。
      // 1. 對於商品搜尋：若設定類目，則以設定的為準；若不設定類目，將由系統進行類目預測，預測的類目結果可在Response中擷取 。
      // 2. 對於布料、商標、通用搜尋：不論是否設定類目，系統會將類目設定為88888888。
      categoryId: 3,
      // 選填，返回結果的數目。取值範圍：1-100。預設值：10。
      num: 10,
      // 選填，返回結果的起始位置。取值範圍：0-499。預設值：0。
      start: 0,// 選填，是否需要進行主體識別，預設為true。
      // 1.為true時，由系統進行主體識別，以識別的主體進行搜尋，主體識別結果可在Response中擷取。
      // 2.為false時，則不進行主體識別，以整張圖進行搜尋。
      // 3.對於布料圖片搜尋，此參數會被忽略，系統會以整張圖進行搜尋。
      crop: true,
      // 選填，圖片的主體地區，格式為 x1,x2,y1,y2, 其中 x1,y1 是左上方的點，x2，y2是右下角的點。設定的region 地區不要超過圖片的邊界。
      // 若使用者佈建了Region，則不論Crop參數為何值，都將以使用者輸入Region進行搜尋。
      // 3.對於布料圖片搜尋，此參數會被忽略，系統會以整張圖進行搜尋。region: "167,467,221,407",// 選填，過濾條件
      // int_attr支援的操作符有>、>=、<、<=、=，str_attr支援的操作符有=和!=，多個條件之支援AND和OR進行串連。
      // 樣本：
      //  1. 根據IntAttr過濾結果，    int_attr>=100
      //  2. 根據StrAttr過濾結果，    str_attr!="value1"
      //  3. 根據IntAttr和StrAttr聯合過濾結果，int_attr=1000 AND str_attr="value1"
      filter: "int_attr=56 AND str_attr=\"test\""
    });
    let ossRuntime = new oss.RuntimeOptions({});
    const searchImageByPicResponse = await client.searchImageByPicAdvance(searchImageByPicAdvanceRequest, ossRuntime);
    console.log(3, searchImageByPicResponse);
  }
  demo();

• 結果樣本

  SearchImageByPicResponse {
    requestId: 'A38BFBD4-D7AD-4BE9-9606-72BB765A9001',
    success: true,
    code: 0,
    msg: 'success',
    auctions: [
      SearchImageByPicResponseAuctions {
        categoryId: 0,
        productId: '1000',
        picName: 'vae.jpg',
        score:1.0,
        sortExprValues: '7.33136443711219e+24;0'
      },
    ...............
      SearchImageByPicResponseAuctions {
        categoryId: 0,
        productId: '123455',
        picName: 'this',
        score:1.0,
        sortExprValues: '7.33136443711219e+24;0'
      }
    ],
    head: SearchImageByPicResponseHead {
      docsReturn: 5,
      docsFound: 5,
      searchTime: 218
    },
    picInfo: SearchImageByPicResponsePicInfo {
      categoryId: 0,
      region: '167,477,221,407',
      allCategories: [
        [SearchImageByPicResponsePicInfoAllCategories],
        ........
        [SearchImageByPicResponsePicInfoAllCategories]
      ],
      "multiRegion": [
         [SearchImageByPicResponseBodyPicInfoMultiRegion],
        ........
        [SearchImageByPicResponseBodyPicInfoMultiRegion]
      ]
    }
  }

SearchImageByName介面

• 程式碼範例

  const oss = require('@alicloud/oss-util');
  const fs = require('fs');
  const imagesearch = require('@alicloud/imagesearch20201214')
  // 建立AK/SK參考：https://www.alibabacloud.com/help/zh/resource-access-management/latest/accesskey-pairs-create-an-accesskey-pair-for-a-ram-user
  const client = new imagesearch.default({
    // 阿里雲帳號AccessKey擁有所有API的存取權限，建議您使用RAM使用者進行API訪問或日常營運。
    // 強烈建議不要把AccessKey ID和AccessKey Secret儲存到工程代碼裡，否則可能導致AccessKey泄露，威脅您帳號下所有資源的安全。
    // 本樣本以將AccessKey ID和AccessKey Secret儲存在環境變數為例說明。您也可以根據業務需要，儲存到設定檔裡。
    accessKeyId: process.env.CC_AK_ENV,
    accessKeySecret: process.env.CC_SK_ENV,
    type: "access_key",
    // 請更換成您購買執行個體的地區，例如購買的是杭州地區，則endpoint="imagesearch.cn-hangzhou.aliyuncs.com"
    endpoint: "imagesearch.cn-shanghai.aliyuncs.com",
  
    // 以下為內網（VPC）訪問方式
    // 說明：內網（VPC）訪問：僅限同地區ECS或資源的訪問，例如您購買的Image Search執行個體是華東2（上海），那麼您的ECS或資源也必須在華東2（上海）才能通過內網VPC地址訪問圖搜服務，否則會調用不通，如果遇到調用不通，請先檢查您的ECS或資源與Image Search是否在同一個地區。
    // endpointType : "internal",  // 如果是內網訪問Image Search服務，則endpointType為必填項，值統一為"internal"
    // endpoint : "imagesearch-vpc.cn-shanghai.aliyuncs.com", // 為內網訪問（VPC）地址，請您更換為您購買執行個體的地區，例如您購買執行個體的地區為杭州，則endpoint="imagesearch-vpc.cn-hangzhou.aliyuncs.com"
  
    // 請您更換成您購買執行個體的地區，例如您購買的執行個體地區為杭州，則更換為regionId="cn-hangzhou"
    regionId: "cn-shanghai",
    protocol: 'http'
  });
  var picContent = fs.createReadStream("D:/123.jpg");
  async function demo() {
    const searchImageByNameRequest = new imagesearch.SearchImageByNameRequest({
      // 必填，Image Search執行個體名稱。注意是執行個體名稱不是執行個體ID。購買後通過上雲層管控台執行個體資訊一欄查看：https://imagesearch.console.aliyun.com/overview
      instanceName: "XXXXXXX",
      // 必填，商品id，最多支援 512個字元。
      // 一個商品可有多張圖片。
      productId: "123455",
      // 必填，圖片名稱，最多支援 512個字元。
     // 1. ProductId + PicName唯一確定一張圖片。
      picName: "this",
      // 選填，商品類目。
      // 1. 對於商品搜尋：若設定類目，則以設定的為準；若不設定類目，將由系統進行類目預測，預測的類目結果可在Response中擷取 。
      // 2. 對於布料、商標、通用搜尋：不論是否設定類目，系統會將類目設定為88888888。
      categoryId: 3,
      // 選填，返回結果的數目。取值範圍：1-100。預設值：10。
      num: 10,
      // 選填，返回結果的起始位置。取值範圍：0-499。預設值：0。
      start: 0,// 選填，是否需要進行主體識別，預設為true。
      // 1.為true時，由系統進行主體識別，以識別的主體進行搜尋，主體識別結果可在Response中擷取。
      // 2. 為false時，則不進行主體識別，以整張圖進行搜尋。
      // 3.對於布料圖片搜尋，此參數會被忽略，系統會以整張圖進行搜尋。
      crop: true,
      // 選填，圖片的主體地區，格式為 x1,x2,y1,y2, 其中 x1,y1 是左上方的點，x2，y2是右下角的點。設定的region 地區不要超過圖片的邊界。
      // 若使用者佈建了Region，則不論Crop參數為何值，都將以使用者輸入Region進行搜尋。
      // 3.對於布料圖片搜尋，此參數會被忽略，系統會以整張圖進行搜尋。region: "167,467,221,407",// 選填，過濾條件
      // int_attr支援的操作符有>、>=、<、<=、=，str_attr支援的操作符有=和!=，多個條件之支援AND和OR進行串連。
      // 樣本：
      //  1. 根據IntAttr過濾結果，    int_attr>=100
      //  2. 根據StrAttr過濾結果，    str_attr!="value1"
      //  3. 根據IntAttr和StrAttr聯合過濾結果，int_attr=1000 AND str_attr="value1"
      filter: "int_attr=56 AND str_attr=\"test\""
    });
    const searchImageByNameResponse = await client.searchImageByName(searchImageByNameRequest);
    console.log(2, searchImageByNameResponse);
  }
  demo();

• 結果樣本

  SearchImageByNameResponse {
    requestId: '4B039098-B274-41DE-9A55-32550B6F74E1',
    success: true,
    code: 0,
    msg: 'success',
    auctions: [
      SearchImageByNameResponseAuctions {
        categoryId: 0,
        productId: '1000',
        picName: 'vae.jpg',
        score:1.0,
        sortExprValues: '7.33136443711219e+24;0'
      },
        .........
      SearchImageByNameResponseAuctions {
        categoryId: 0,
        productId: '123455',
        picName: 'this',
        score:1.0,
        sortExprValues: '7.33136443711219e+24;0'
      }
    ],
    head: SearchImageByNameResponseHead {
      docsReturn: 5,
      docsFound: 5,
      searchTime: 11
    },
    picInfo: SearchImageByNameResponsePicInfo {
      categoryId: 0,
        allCategories: [
        [SearchImageByNameResponsePicInfoAllCategories],
        ......
        [SearchImageByNameResponsePicInfoAllCategories]
      ],
       "multiRegion": [
         [SearchImageByPicResponseBodyPicInfoMultiRegion],
        ........
        [SearchImageByPicResponseBodyPicInfoMultiRegion]
      ]
    }
  }

Delete介面

• 程式碼範例

  const oss = require('@alicloud/oss-util');
  const fs = require('fs');
  const imagesearch = require('@alicloud/imagesearch20201214')
  // 建立AK/SK參考：https://www.alibabacloud.com/help/zh/resource-access-management/latest/accesskey-pairs-create-an-accesskey-pair-for-a-ram-user
  const client = new imagesearch.default({
    // 阿里雲帳號AccessKey擁有所有API的存取權限，建議您使用RAM使用者進行API訪問或日常營運。
    // 強烈建議不要把AccessKey ID和AccessKey Secret儲存到工程代碼裡，否則可能導致AccessKey泄露，威脅您帳號下所有資源的安全。
    // 本樣本以將AccessKey ID和AccessKey Secret儲存在環境變數為例說明。您也可以根據業務需要，儲存到設定檔裡。
    accessKeyId: process.env.CC_AK_ENV,
    accessKeySecret: process.env.CC_SK_ENV,
    type: "access_key",
    // 請更換成您購買執行個體的地區，例如購買的是杭州地區，則endpoint="imagesearch.cn-hangzhou.aliyuncs.com"
    endpoint: "imagesearch.cn-shanghai.aliyuncs.com",
  
    // 以下為內網（VPC）訪問方式
    // 說明：內網（VPC）訪問：僅限同地區ECS或資源的訪問，例如您購買的Image Search執行個體是華東2（上海），那麼您的ECS或資源也必須在華東2（上海）才能通過內網VPC地址訪問圖搜服務，否則會調用不通，如果遇到調用不通，請先檢查您的ECS或資源與Image Search是否在同一個地區。
    // endpointType : "internal",  // 如果是內網訪問Image Search服務，則endpointType為必填項，值統一為"internal"
    // endpoint : "imagesearch-vpc.cn-shanghai.aliyuncs.com", // 為內網訪問（VPC）地址，請您更換為您購買執行個體的地區，例如您購買執行個體的地區為杭州，則endpoint="imagesearch-vpc.cn-hangzhou.aliyuncs.com"
  
    // 請您更換成您購買執行個體的地區，例如您購買的執行個體地區為杭州，則更換為regionId="cn-hangzhou"
    regionId: "cn-shanghai",
    protocol: 'http'
  });
  async function demo() {
    const deleteImageRequest = new imagesearch.DeleteImageRequest({
      // 必填，Image Search執行個體名稱。注意是執行個體名稱不是執行個體ID。購買後通過上雲層管控台執行個體資訊一欄查看：https://imagesearch.console.aliyun.com/overview
      instanceName: "XXXXXXXXXXXXXXXXXX",
       // 必填，商品id，最多支援 512個字元。
       //一個商品可有多張圖片。
      productId: "123455",
       //  選填，圖片名稱。若不指定本參數，則刪除ProductId下所有圖片；若指定本參數，則刪除ProductId+PicName指定的圖片。
      picName: "this"
    });
    const deleteImageResponse = await client.deleteImage(deleteImageRequest);
    console.log(4, deleteImageResponse);
  }
  demo();

• 結果樣本

  DeleteImageResponse {
    requestId: '3965B44B-0584-41DE-8764-0D8B36857CE1',
    success: true,
    message: 'success',
    code: 0
  }

UpdateImage介面

• 程式碼範例

  const oss = require('@alicloud/oss-util');
  const fs = require('fs');
  const imagesearch = require('@alicloud/imagesearch20201214')
  // 建立AK/SK參考：https://www.alibabacloud.com/help/zh/resource-access-management/latest/accesskey-pairs-create-an-accesskey-pair-for-a-ram-user
  const client = new imagesearch.default({
    // 阿里雲帳號AccessKey擁有所有API的存取權限，建議您使用RAM使用者進行API訪問或日常營運。
    // 強烈建議不要把AccessKey ID和AccessKey Secret儲存到工程代碼裡，否則可能導致AccessKey泄露，威脅您帳號下所有資源的安全。
    // 本樣本以將AccessKey ID和AccessKey Secret儲存在環境變數為例說明。您也可以根據業務需要，儲存到設定檔裡。
    accessKeyId: process.env.CC_AK_ENV,
    accessKeySecret: process.env.CC_SK_ENV,
    type: "access_key",
    // 請更換成您購買執行個體的地區，例如購買的是杭州地區，則endpoint="imagesearch.cn-hangzhou.aliyuncs.com"
    endpoint: "imagesearch.cn-shanghai.aliyuncs.com",
  
    // 以下為內網（VPC）訪問方式
    // 說明：內網（VPC）訪問：僅限同地區ECS或資源的訪問，例如您購買的Image Search執行個體是華東2（上海），那麼您的ECS或資源也必須在華東2（上海）才能通過內網VPC地址訪問圖搜服務，否則會調用不通，如果遇到調用不通，請先檢查您的ECS或資源與Image Search是否在同一個地區。
    // endpointType : "internal",  // 如果是內網訪問Image Search服務，則endpointType為必填項，值統一為"internal"
    // endpoint : "imagesearch-vpc.cn-shanghai.aliyuncs.com", // 為內網訪問（VPC）地址，請您更換為您購買執行個體的地區，例如您購買執行個體的地區為杭州，則endpoint="imagesearch-vpc.cn-hangzhou.aliyuncs.com"
  
    // 請您更換成您購買執行個體的地區，例如您購買的執行個體地區為杭州，則更換為regionId="cn-hangzhou"
    regionId: "cn-shanghai",
    protocol: 'http'
  });
  async function updateImage() {
    const request = new imagesearch.UpdateImageRequest({
      // 必填，Image Search執行個體名稱。注意是執行個體名稱不是執行個體ID。購買後通過上雲層管控台執行個體資訊一欄查看：https://imagesearch.console.aliyun.com/overview
      instanceName: "XXXXXXXXXXXXXXXXXX",
      // 必填，商品ID 不可修改。
      productId: "1",
      // 必填，圖片名稱，不可修改。
      picName: "1",
      // 選填，整數類型屬性，可用於查詢時過濾，查詢時會返回該欄位。
      intAttr: "11",
      // 選填，字串類型屬性，最多支援 128個字元。可用於查詢時過濾，查詢時會返回該欄位。
      strAttr: "text",
      // 選填，使用者自訂的內容，最多支援4096個字元。
      customContent: "測試說明"
    });
    const response = await client.updateImage(request);
    console.log(4, response.body.toMap());
  }
  updateImage();

• 結果樣本

  4 {
    Code: 0,
    RequestId: '1DD89D33-9D60-179A-9D3E-07CA381F07B5',
    Success: true
  }
                      

Detail介面

• 程式碼範例

  const oss = require('@alicloud/oss-util');
  const fs = require('fs');
  const imagesearch = require('@alicloud/imagesearch20201214')
  // 建立AK/SK參考：https://www.alibabacloud.com/help/zh/resource-access-management/latest/accesskey-pairs-create-an-accesskey-pair-for-a-ram-user
  const client = new imagesearch.default({
    // 阿里雲帳號AccessKey擁有所有API的存取權限，建議您使用RAM使用者進行API訪問或日常營運。
    // 強烈建議不要把AccessKey ID和AccessKey Secret儲存到工程代碼裡，否則可能導致AccessKey泄露，威脅您帳號下所有資源的安全。
    // 本樣本以將AccessKey ID和AccessKey Secret儲存在環境變數為例說明。您也可以根據業務需要，儲存到設定檔裡。
    accessKeyId: process.env.CC_AK_ENV,
    accessKeySecret: process.env.CC_SK_ENV,
    type: "access_key",
    // 請更換成您購買執行個體的地區，例如購買的是杭州地區，則endpoint="imagesearch.cn-hangzhou.aliyuncs.com"
    endpoint: "imagesearch.cn-shanghai.aliyuncs.com",
  
    // 以下為內網（VPC）訪問方式
    // 說明：內網（VPC）訪問：僅限同地區ECS或資源的訪問，例如您購買的Image Search執行個體是華東2（上海），那麼您的ECS或資源也必須在華東2（上海）才能通過內網VPC地址訪問圖搜服務，否則會調用不通，如果遇到調用不通，請先檢查您的ECS或資源與Image Search是否在同一個地區。
    // endpointType : "internal",  // 如果是內網訪問Image Search服務，則endpointType為必填項，值統一為"internal"
    // endpoint : "imagesearch-vpc.cn-shanghai.aliyuncs.com", // 為內網訪問（VPC）地址，請您更換為您購買執行個體的地區，例如您購買執行個體的地區為杭州，則endpoint="imagesearch-vpc.cn-hangzhou.aliyuncs.com"
  
    // 請您更換成您購買執行個體的地區，例如您購買的執行個體地區為杭州，則更換為regionId="cn-hangzhou"
    regionId: "cn-shanghai",
    protocol: 'http'
  });
  async function detail() {
    const request = new imagesearch.DetailRequest({
      // 必填，Image Search執行個體名稱。注意是執行個體名稱不是執行個體ID。購買後通過上雲層管控台執行個體資訊一欄查看：https://imagesearch.console.aliyun.com/overview
      instanceName: "XXXXXXXXXXXXXXXXXX"
    });
    const response = await client.detail(request);
    console.log(4, response.body.toMap());
  }
  detail();

• 結果樣本

  4 {
    Instance: {
      Capacity: 10,
      Name: 'xxxxxx',
      Qps: 1,
      Region: 'cn-shanghai',
      ServiceType: 0,
      TotalCount: 99999,
      UtcCreate: '1620382716000',
      UtcExpireTime: '1623081600000'
    },
    RequestId: '84ADF9D3-3668-1837-B0A9-ADB093F77DB2',
    Success: true
  }
                      

DumpMeta介面

• 程式碼範例

  const oss = require('@alicloud/oss-util');
  const fs = require('fs');
  const imagesearch = require('@alicloud/imagesearch20201214')
  // 建立AK/SK參考：https://www.alibabacloud.com/help/zh/resource-access-management/latest/accesskey-pairs-create-an-accesskey-pair-for-a-ram-user
  const client = new imagesearch.default({
    // 阿里雲帳號AccessKey擁有所有API的存取權限，建議您使用RAM使用者進行API訪問或日常營運。
    // 強烈建議不要把AccessKey ID和AccessKey Secret儲存到工程代碼裡，否則可能導致AccessKey泄露，威脅您帳號下所有資源的安全。
    // 本樣本以將AccessKey ID和AccessKey Secret儲存在環境變數為例說明。您也可以根據業務需要，儲存到設定檔裡。
    accessKeyId: process.env.CC_AK_ENV,
    accessKeySecret: process.env.CC_SK_ENV,
    type: "access_key",
    // 請更換成您購買執行個體的地區，例如購買的是杭州地區，則endpoint="imagesearch.cn-hangzhou.aliyuncs.com"
    endpoint: "imagesearch.cn-shanghai.aliyuncs.com",
  
    // 以下為內網（VPC）訪問方式
    // 說明：內網（VPC）訪問：僅限同地區ECS或資源的訪問，例如您購買的Image Search執行個體是華東2（上海），那麼您的ECS或資源也必須在華東2（上海）才能通過內網VPC地址訪問圖搜服務，否則會調用不通，如果遇到調用不通，請先檢查您的ECS或資源與Image Search是否在同一個地區。
    // endpointType : "internal",  // 如果是內網訪問Image Search服務，則endpointType為必填項，值統一為"internal"
    // endpoint : "imagesearch-vpc.cn-shanghai.aliyuncs.com", // 為內網訪問（VPC）地址，請您更換為您購買執行個體的地區，例如您購買執行個體的地區為杭州，則endpoint="imagesearch-vpc.cn-hangzhou.aliyuncs.com"
  
    // 請您更換成您購買執行個體的地區，例如您購買的執行個體地區為杭州，則更換為regionId="cn-hangzhou"
    regionId: "cn-shanghai",
    protocol: 'http'
  });
  async function dumpMeta() {
    const request = new imagesearch.DumpMetaRequest({
      // 必填，Image Search執行個體名稱。注意是執行個體名稱不是執行個體ID。購買後通過上雲層管控台執行個體資訊一欄查看：https://imagesearch.console.aliyun.com/overview
      instanceName: "XXXXXXXXXXXXXXXXXX"
    });
    const response = await client.dumpMeta(request);
    console.log(4, response.body.toMap());
  }
  dumpMeta();

• 結果樣本

  4 {
    Data: { DumpMetaStatus: 'PROCESSING', Id: '571' },
    RequestId: '8B639BD9-5EAB-127D-89EF-3EBE3277E02F',
    Success: true
  }
                      

DumpMetaList介面

• 程式碼範例

  const oss = require('@alicloud/oss-util');
  const fs = require('fs');
  const imagesearch = require('@alicloud/imagesearch20201214')
  // 建立AK/SK參考：https://www.alibabacloud.com/help/zh/resource-access-management/latest/accesskey-pairs-create-an-accesskey-pair-for-a-ram-user
  const client = new imagesearch.default({
    // 阿里雲帳號AccessKey擁有所有API的存取權限，建議您使用RAM使用者進行API訪問或日常營運。
    // 強烈建議不要把AccessKey ID和AccessKey Secret儲存到工程代碼裡，否則可能導致AccessKey泄露，威脅您帳號下所有資源的安全。
    // 本樣本以將AccessKey ID和AccessKey Secret儲存在環境變數為例說明。您也可以根據業務需要，儲存到設定檔裡。
    accessKeyId: process.env.CC_AK_ENV,
    accessKeySecret: process.env.CC_SK_ENV,
    type: "access_key",
    // 請更換成您購買執行個體的地區，例如購買的是杭州地區，則endpoint="imagesearch.cn-hangzhou.aliyuncs.com"
    endpoint: "imagesearch.cn-shanghai.aliyuncs.com",
  
    // 以下為內網（VPC）訪問方式
    // 說明：內網（VPC）訪問：僅限同地區ECS或資源的訪問，例如您購買的Image Search執行個體是華東2（上海），那麼您的ECS或資源也必須在華東2（上海）才能通過內網VPC地址訪問圖搜服務，否則會調用不通，如果遇到調用不通，請先檢查您的ECS或資源與Image Search是否在同一個地區。
    // endpointType : "internal",  // 如果是內網訪問Image Search服務，則endpointType為必填項，值統一為"internal"
    // endpoint : "imagesearch-vpc.cn-shanghai.aliyuncs.com", // 為內網訪問（VPC）地址，請您更換為您購買執行個體的地區，例如您購買執行個體的地區為杭州，則endpoint="imagesearch-vpc.cn-hangzhou.aliyuncs.com"
  
    // 請您更換成您購買執行個體的地區，例如您購買的執行個體地區為杭州，則更換為regionId="cn-hangzhou"
    regionId: "cn-shanghai",
    protocol: 'http'
  });
  async function dumpMetaList() {
    const request = new imagesearch.DumpMetaListRequest({
      // 必填，Image Search執行個體名稱。注意是執行個體名稱不是執行個體ID。購買後通過上雲層管控台執行個體資訊一欄查看：https://imagesearch.console.aliyun.com/overview
      instanceName: "XXXXXXXXXXXXXXXXXX",
      // 選填，中繼資料匯出任務id。
      id: 567,
      // 選填，返回結果起始位置，預設1。
      pageNumber: 1,
      // 選填，返回結果數量，預設20。
      pageSize: 1
    });
    const response = await client.dumpMetaList(request);
    console.log(4, response.body.toMap());
    console.log(4, response.body.data.dumpMetaList);
  }
  dumpMetaList();

• 結果樣本

  4 {
    Data: {
      DumpMetaList: [ [Object] ],
      PageNumber: 1,
      PageSize: 1,
      TotalCount: 1
    },
    RequestId: 'BFE47106-BF23-1581-A3AB-F3F54D8866BC'
  }
  4 [
    DumpMetaListResponseBodyDataDumpMetaList {
      code: '0',
      id: 567,
      metaUrl: 'https://xxx/xxx',
      msg: 'success',
      status: 'SUCCESS',
      utcCreate: '1639969113000',
      utcModified: 1639969140000
    }
  ]
  
                      

BatchTask介面

• 程式碼範例

  const oss = require('@alicloud/oss-util');
  const fs = require('fs');
  const imagesearch = require('@alicloud/imagesearch20201214')
  // 建立AK/SK參考：https://www.alibabacloud.com/help/zh/resource-access-management/latest/accesskey-pairs-create-an-accesskey-pair-for-a-ram-user
  const client = new imagesearch.default({
    // 阿里雲帳號AccessKey擁有所有API的存取權限，建議您使用RAM使用者進行API訪問或日常營運。
    // 強烈建議不要把AccessKey ID和AccessKey Secret儲存到工程代碼裡，否則可能導致AccessKey泄露，威脅您帳號下所有資源的安全。
    // 本樣本以將AccessKey ID和AccessKey Secret儲存在環境變數為例說明。您也可以根據業務需要，儲存到設定檔裡。
    accessKeyId: process.env.CC_AK_ENV,
    accessKeySecret: process.env.CC_SK_ENV,
    type: "access_key",
    // 請更換成您購買執行個體的地區，例如購買的是杭州地區，則endpoint="imagesearch.cn-hangzhou.aliyuncs.com"
    endpoint: "imagesearch.cn-shanghai.aliyuncs.com",
  
    // 以下為內網（VPC）訪問方式
    // 說明：內網（VPC）訪問：僅限同地區ECS或資源的訪問，例如您購買的Image Search執行個體是華東2（上海），那麼您的ECS或資源也必須在華東2（上海）才能通過內網VPC地址訪問圖搜服務，否則會調用不通，如果遇到調用不通，請先檢查您的ECS或資源與Image Search是否在同一個地區。
    // endpointType : "internal",  // 如果是內網訪問Image Search服務，則endpointType為必填項，值統一為"internal"
    // endpoint : "imagesearch-vpc.cn-shanghai.aliyuncs.com", // 為內網訪問（VPC）地址，請您更換為您購買執行個體的地區，例如您購買執行個體的地區為杭州，則endpoint="imagesearch-vpc.cn-hangzhou.aliyuncs.com"
  
    // 請您更換成您購買執行個體的地區，例如您購買的執行個體地區為杭州，則更換為regionId="cn-hangzhou"
    regionId: "cn-shanghai",
    protocol: 'http'
  });
  async function batchTask() {
    const request = new imagesearch.IncreaseInstanceRequest({
      // 必填，Image Search執行個體名稱。注意是執行個體名稱不是執行個體ID。購買後通過上雲層管控台執行個體資訊一欄查看：https://imagesearch.console.aliyun.com/overview
      instanceName: "XXXXXXXXXXXXXXXXXX",
      // 必填，oss 中 bucket名稱。
      bucketName: "xxxx",
      // 必填，路徑，必須 / 開頭, 非 / 結尾。
      // 此路徑下需要提前準備好 increment.meta 檔案，可參考，使用者指南下的大量操作文檔。
      path: "/public/xxx",
      // 選填，請求成功回調地址，http(s)://。
      callbackAddress: "http://xxx/xx"
    });
    const response = await client.increaseInstance(request);
    console.log(4, response.body.toMap());
  }
  batchTask();

• 結果樣本

  4 {
    Data: { Id: '1474', IncrementStatus: 'PROCESSING' },
    RequestId: 'E2AF05CC-F642-1481-BD97-70DC7EBAF7C8',
    Success: true
  }
                      

BatchTaskList介面

• 程式碼範例

  const oss = require('@alicloud/oss-util');
  const fs = require('fs');
  const imagesearch = require('@alicloud/imagesearch20201214')
  // 建立AK/SK參考：https://www.alibabacloud.com/help/zh/resource-access-management/latest/accesskey-pairs-create-an-accesskey-pair-for-a-ram-user
  const client = new imagesearch.default({
    // 阿里雲帳號AccessKey擁有所有API的存取權限，建議您使用RAM使用者進行API訪問或日常營運。
    // 強烈建議不要把AccessKey ID和AccessKey Secret儲存到工程代碼裡，否則可能導致AccessKey泄露，威脅您帳號下所有資源的安全。
    // 本樣本以將AccessKey ID和AccessKey Secret儲存在環境變數為例說明。您也可以根據業務需要，儲存到設定檔裡。
    accessKeyId: process.env.CC_AK_ENV,
    accessKeySecret: process.env.CC_SK_ENV,
    type: "access_key",
    // 請更換成您購買執行個體的地區，例如購買的是杭州地區，則endpoint="imagesearch.cn-hangzhou.aliyuncs.com"
    endpoint: "imagesearch.cn-shanghai.aliyuncs.com",
  
    // 以下為內網（VPC）訪問方式
    // 說明：內網（VPC）訪問：僅限同地區ECS或資源的訪問，例如您購買的Image Search執行個體是華東2（上海），那麼您的ECS或資源也必須在華東2（上海）才能通過內網VPC地址訪問圖搜服務，否則會調用不通，如果遇到調用不通，請先檢查您的ECS或資源與Image Search是否在同一個地區。
    // endpointType : "internal",  // 如果是內網訪問Image Search服務，則endpointType為必填項，值統一為"internal"
    // endpoint : "imagesearch-vpc.cn-shanghai.aliyuncs.com", // 為內網訪問（VPC）地址，請您更換為您購買執行個體的地區，例如您購買執行個體的地區為杭州，則endpoint="imagesearch-vpc.cn-hangzhou.aliyuncs.com"
  
    // 請您更換成您購買執行個體的地區，例如您購買的執行個體地區為杭州，則更換為regionId="cn-hangzhou"
    regionId: "cn-shanghai",
    protocol: 'http'
  });
  async function batchTaskList() {
    const request = new imagesearch.IncreaseListRequest({
      // 必填，Image Search執行個體名稱。注意是執行個體名稱不是執行個體ID。購買後通過上雲層管控台執行個體資訊一欄查看：https://imagesearch.console.aliyun.com/overview
      instanceName: "XXXXXXXXXXXXXXXXXX",
      // 必填 oss 中 bucket名稱。
      bucketName: "xxxx",
      // 必填，路徑，必須 / 開頭, 非 / 結尾。
      path: "/public/xxx",
      // 選填，中繼資料匯出任務id。
      id: 1464,
      // 選填，返回結果起始位置，預設1。
      pageNumber: 1,
      // 選填，返回結果數量，預設20。
      pageSize: 1
    });
    const response = await client.increaseList(request);
    console.log(4, response.body.toMap());
    console.log(4, response.body.data.increments.toMap());
  }
  batchTaskList();

• 結果樣本

  4 {
    Data: {
      Increments: { Instance: [Array] },
      PageNumber: 1,
      PageSize: 1,
      TotalCount: 1
    },
    RequestId: 'F51B5D0D-3E10-170B-88ED-79997736C6E8'
  }
  4 {
    Instance: [
      {
        BucketName: 'cccxxx',
        Code: '0',
        ErrorUrl: 'https://x/x',
        Id: 1464,
        Msg: 'success',
        Path: '/public/xxx',
        Status: 'NORMAL',
        UtcCreate: '1639107872000',
        UtcModified: 1639125540000
      }
    ]
  }