Object Storage Service：Node.js靜態網站託管（鏡像回源）

靜態網站託管

靜態網站是指所有的網頁都由靜態內容構成，包括用戶端執行的指令碼（例如JavaScript）。您可以通過靜態網站託管功能將您的靜態網站託管到Bucket，並使用Bucket的訪問網域名稱訪問這個網站。

• 設定靜態網站託管

  以下代碼用於設定靜態網站託管：

  const OSS = require('ali-oss')
  
  const client = new OSS({
    // yourRegion填寫Bucket所在地區。以華東1（杭州）為例，Region填寫為oss-cn-hangzhou。
    region: 'yourRegion',
    // 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
    accessKeyId: process.env.OSS_ACCESS_KEY_ID,
    accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET,
    authorizationV4: true,
    // yourBucketName填寫Bucket名稱。
    bucket: 'yourBucketName',
  });
  
  // 設定靜態網站託管。
  async function putBucketWebsite () {
    try {
      // 填寫Bucket名稱，例如examplebucket。    
      const result = await client.putBucketWebsite('examplebucket', {
      // 設定靜態網站託管的預設首頁。
      index: 'index.html',
      // 設定靜態網站託管的預設404頁。
      error: 'error.html'
    });
     console.log(result);
    } catch (e) {
      console.log(e);
    }
  }
  
  putBucketWebsite();            

• 查看靜態網站託管配置

  以下代碼用於查看靜態網站託管配置：

  const OSS = require('ali-oss')
  
  const client = new OSS({
    // yourRegion填寫Bucket所在地區。以華東1（杭州）為例，Region填寫為oss-cn-hangzhou。
    region: 'yourRegion',
    // 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
    accessKeyId: process.env.OSS_ACCESS_KEY_ID,
    accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET,
    authorizationV4: true,
    // yourBucketName填寫Bucket名稱。
    bucket: 'yourBucketName',
  });
  
  // 查看靜態網站託管配置的預設首頁和預設404頁。
  async function getBucketWebsite () {
    try {
      // 填寫Bucket名稱，例如examplebucket。
      const result = await client.getBucketWebsite('examplebucket');
      console.log(result);
    } catch (e) {
      console.log(e);
    }
  }
  
  getBucketWebsite();            

• 刪除靜態網站託管配置

  以下代碼用於刪除靜態網站託管配置：

  const OSS = require('ali-oss')
  
  const client = new OSS({
    // yourRegion填寫Bucket所在地區。以華東1（杭州）為例，Region填寫為oss-cn-hangzhou。
    region: 'yourRegion',
    // 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
    accessKeyId: process.env.OSS_ACCESS_KEY_ID,
    accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET,
    authorizationV4: true,
    // yourBucketName填寫Bucket名稱。
    bucket: 'yourBucketName',
  });
  
  // 刪除靜態網站託管配置。
  async function deleteBucketWebsite() {
    try {
      // 填寫Bucket名稱，例如examplebucket。
      const result = await client.deleteBucketWebsite('examplebucket');
      console.log(result);
    } catch (e) {
      console.log(e);
    }
  }
  
  deleteBucketWebsite();            

鏡像回源

鏡像回源主要用於資料無縫遷移到OSS的情境。例如某服務已經在使用者建立的來源站點或者在其他雲產品上運行，現因業務發展，需要將服務遷移至OSS，遷移時需保證服務的正常運行。您可以在遷移過程中使用鏡像回源規則擷取未遷移至OSS的部分資料，保證服務的正常運行。

• 設定鏡像回源

  例如，當要求者訪問目標Bucket中不存在的檔案時，可以通過指定回源條件和回源地址，從來源站點中擷取目標檔案。例如您在華東1（杭州）有名為examplebucket的Bucket，您希望要求者訪問Bucket根目錄下examplefolder目錄中不存在的檔案時，可以從https://www.example.com/網站的examplefolder目錄擷取目標檔案。

  以下代碼用於設定符合上述情境的鏡像回源規則：

  const OSS = require('ali-oss')
  constpath=require("path")
  
  const client = new OSS({
    // yourRegion填寫Bucket所在地區。以華東1（杭州）為例，Region填寫為oss-cn-hangzhou。
    region: 'yourRegion',
    // 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
    accessKeyId: process.env.OSS_ACCESS_KEY_ID,
    accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET,
    authorizationV4: true,
    // yourBucketName填寫Bucket名稱。
    bucket: 'yourBucketName',
  });
  
  async function putBucketWebsite() {
    try {
      // 填寫Bucket名稱，例如examplebucket。
      const result = await client.putBucketWebsite("examplebucket", {
        // 設定靜態網站託管的預設首頁。
        index: "index.html",
        // 設定靜態網站託管的預設404頁。
        error: "error.html",
        // 指定訪問子目錄時，是否支援轉到子目錄下的預設首頁。
        // supportSubDir:true ,
        // 指定設定預設首頁後，訪問以非正斜線（/）結尾的Object，且該Object不存在時的行為。僅在SupportSubDir設定為true時生效。
        // type: 0 ,
        routingRules: [
           { RuleNumber: 1,
               // 只有匹配此首碼的Object才能匹配此規則。
               Condition: { KeyPrefixEquals: "examplefolder/" ,
                            // 訪問指定Object時，返回status 404才能匹配此規則。
                            HttpErrorCodeReturnedEquals: 404
                          },
               // 指定跳轉的類型。
               Redirect: { RedirectType: "Mirror",
                           // 指定執行跳轉或者鏡像回源規則時，是否攜帶請求參數。
                           PassQueryString: true,
                           // 指定鏡像回源的來源站點地址。
                           MirrorURL: 'http://example.com/',                         
                           // 與PassQueryString作用相同，優先順序高於PassQueryString。只有設定RedirectType為Mirror時才生效。
                           MirrorPassQueryString:true,
                           // 如果鏡像回源擷取的結果為3xx，是否繼續跳轉到指定的Location擷取資料。只有設定RedirectType為Mirror時才生效。此處設定此項為true，表明OSS會繼續請求Location對應的地址。
                           MirrorFollowRedirect:true,
                           // 是否檢查回源body的MD5。
                           MirrorCheckMd5:false,
                           // 指定鏡像回源時攜帶的Header。
                           // 是否透傳除以下Header之外的其他Header到來源站點。
                           MirrorHeaders:{ PassAll: true,
                                           // 將Pass中指定的Header透傳到來源站點。
                                           Pass:'myheader-key1',
                                           Pass:'myheader-key2',
                                           // 禁止將Remove中指定的Header透傳到來源站點。
                                           Remove:'myheader-key3',
                                           Remove:'myheader-key4'}
                          }}
         ] 
      });
      console.log(result);
    } catch (e) {
      console.log(e);
    }
  }
  
  putBucketWebsite();

• 擷取鏡像回源配置

  以下代碼用於擷取鏡像回源配置：

  const OSS = require('ali-oss')
  constpath=require("path")
  
  const client = new OSS({
    // yourRegion填寫Bucket所在地區。以華東1（杭州）為例，Region填寫為oss-cn-hangzhou。
    region: 'yourRegion',
    // 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
    accessKeyId: process.env.OSS_ACCESS_KEY_ID,
    accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET,
    authorizationV4: true,
    // yourBucketName填寫Bucket名稱。
    bucket: 'yourBucketName',
  });
  
  // 擷取鏡像回源配置。
  async function getBucketWebsite () {
    try {
      // 填寫Bucket名稱，例如examplebucket。
      const result = await client.getBucketWebsite('examplebucket');
      console.log(result);
    } catch (e) {
      console.log(e);
    }
  }
  
  getBucketWebsite();            

• 刪除鏡像回源配置

  以下代碼用於刪除鏡像回源配置：

  const OSS = require('ali-oss')
  constpath=require("path")
  
  const client = new OSS({
    // yourRegion填寫Bucket所在地區。以華東1（杭州）為例，Region填寫為oss-cn-hangzhou。
    region: 'yourRegion',
    // 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
    accessKeyId: process.env.OSS_ACCESS_KEY_ID,
    accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET,
    authorizationV4: true,
    // yourBucketName填寫Bucket名稱。
    bucket: 'yourBucketName',
  });
  
  // 刪除鏡像回源配置。
  async function deleteBucketWebsite() {
    try {
      // 填寫Bucket名稱，例如examplebucket。
      const result = await client.deleteBucketWebsite('examplebucket');
      console.log(result);
    } catch (e) {
      console.log(e);
    }
  }
  
  deleteBucketWebsite();            

相關文檔

• 關於設定靜態網站託管或者鏡像回源的API介面說明，請參見PutBucketWebsite。

• 關於擷取靜態網站託管或者鏡像回源的API介面說明，請參見GetBucketWebsite。

• 關於刪除靜態網站託管或者鏡像回源的API介面說明，請參見DeleteBucketWebsite。