在複製活動中設定 REST
本文概述如何使用資料管線中的複製活動,從 REST 端點複製資料及將資料複製到該處。
具體而言,此泛型 REST 連接器支援:
- 使用 GET 或 POST 方法,從 REST 端點複製資料,並使用 POST、PUT 或 PATCH 方法,將資料複製到 REST 端點。
- REST API 中的分頁。
- 若將 REST 當作來源,請依原狀複製 REST JSON 回應或使用結構描述對應加以剖析。 僅支援 JSON 格式的回應承載。
支援的設定
如需複製活動下每個索引標籤的組態,請分別移至下列各節。
一般
來源
在複製活動的 [來源] 索引標籤下,REST 支援下列屬性。
以下是前三個必要的屬性:
- 資料存放區類型:選取 [外部]。
- 連線:從連線清單中選取 [REST] 連線。 如果不存在連線,請選取 [新增],以建立新的 REST 連線。
- 連線類型:選取 [REST]。
- 相對 URL:包含資料之資源的相對 URL。 若未指定此屬性,則只會使用在連線定義中指定的 URL。 HTTP 連接器會從合併的 URL 複製資料:
[URL specified in connection]/[relative URL specified]
。
在 [進階] 下,您可以指定下列欄位:
要求方法:HTTP 方法。 允許的值為 GET (預設值) 和 POST。
要求逾時:用於取得回應的 HTTP 要求的逾時 (時間範圍值)。 此值是取得回應的逾時值,而非讀取回應資料的逾時值。 預設值為 00:01:40。
要求間隔 (ms):對多個頁面的不同要求之間的間隔時間 (毫秒)。 要求間隔值應為介於 [10, 60000] 之間的數字。
其他標頭:其他 HTTP 要求標頭。
分頁規則:用來撰寫下一個頁面要求的分頁規則。 請參閱分頁支援區段以取得詳細資料。
其他資料行:新增更多資料行以儲存來源檔案的相對路徑或靜態值。 如果使用靜態值,您可以使用自訂運算式加以產生。
Destination
在複製活動的 [目的地] 索引標籤下,REST 支援下列屬性。
以下是前三個必要的屬性:
- 資料存放區類型:選取 [外部]。
- 連線:從連線清單中選取 [REST] 連線。 如果不存在連線,請選取 [新增],以建立新的 REST 連線。
- 連線類型:選取 [REST]。
- 相對 URL:包含資料之資源的相對 URL。 若未指定此屬性,則只會使用在連線定義中指定的 URL。 HTTP 連接器會從合併的 URL 複製資料:
[URL specified in connection]/[relative URL specified]
。
在 [進階] 下,您可以指定下列欄位:
要求方法:HTTP 方法。 允許的值為 POST (預設值)、PUT 和 PATCH。
要求逾時:用於取得回應的 HTTP 要求的逾時 (時間範圍值)。 此值是取得回應的逾時值,而非寫入資料的逾時值。 預設值為 00:01:40。
要求間隔 (ms):對多個頁面的不同要求之間的間隔時間 (毫秒)。 要求間隔值應為介於 [10, 60000] 之間的數字。
寫入批次大小:每個批次要寫入 REST 目的地的記錄數目。 預設值為 10000。
HTTP 壓縮類型:使用最佳壓縮層級傳送資料時使用的 HTTP 壓縮類型。 允許的值為無和 GZip。
其他標頭:其他 HTTP 要求標頭。
對應
如需 [對應] 索引標籤組態,請移至在 [對應] 索引標籤下設定對應。當來源和目的地都是階層式資料時,不支援對應。
設定
如需 [設定] 索引標籤組態,請移至在 [設定] 索引標籤下進行其他設定]。
資料表摘要
下列各表包含有關 REST 中複製活動的詳細資訊。
來源資訊
名稱 | 描述: | 值 | 必要 | JSON 指令碼屬性 |
---|---|---|---|---|
資料存放區類型 | 您的資料存放區類型。 | • 工作區 • 外部 • 範例資料集 |
Yes | type |
[連接] | 您與來源資料存放區的連線。 | <您的連線> | Yes | connection |
連線類型 | 您的連線類型。 選取 [REST]。 | REST | Yes | type: RestResource |
相對 URL | 包含資料之資源的相對 URL。 若未指定此屬性,則只會使用在連線定義中指定的 URL。 HTTP 連接器會從合併的 URL 複製資料:[URL specified in connection]/[relative URL specified] 。 |
<您的相對 URL> | No | relativeUrl |
要求方法 | HTTP 方法。 允許的值為 GET (預設值) 和 POST。 | • GET • POST |
No | requestMethod |
要求逾時 | 用來取得回應的 HTTP 要求的逾時 (時間範圍值)。 此值是取得回應的逾時值,而非讀取回應資料的逾時值。 預設值為 00:01:40。 | 時間範圍 | No | httpRequestTimeout |
要求間隔 (ms) | 對多個頁面的不同要求之間的間隔時間 (毫秒)。 要求間隔值應為介於 [10, 60000] 之間的數字。 | [10, 60000] | No | requestInterval |
其他標頭 | 其他 HTTP 要求標頭。 | <您的其他標頭> | No | additionalHeaders |
分頁規則 | 用來撰寫下一個頁面要求的分頁規則。 請參閱分頁支援區段以取得詳細資料。 | 移至分頁 | No | paginationRules |
其他資料行 | 新增更多資料行以儲存來源檔案的相對路徑或靜態值。 後者支援運算式。 | • 名稱 • 值 |
No | additionalColumns: • 名稱 • 值 |
目的地資訊
名稱 | 描述: | 值 | 必要 | JSON 指令碼屬性 |
---|---|---|---|---|
資料存放區類型 | 您的資料存放區類型。 | • 工作區 • 外部 |
Yes | type |
[連接] | 您與來源資料存放區的連線。 | <您的連線> | Yes | connection |
連線類型 | 您的連線類型。 選取 [REST]。 | REST | Yes | type: RestResource |
相對 URL | 包含資料之資源的相對 URL。 若未指定此屬性,則只會使用在連線定義中指定的 URL。 HTTP 連接器會從合併的 URL 複製資料:[URL specified in connection]/[relative URL specified] 。 |
<您的相對 URL> | No | relativeUrl |
要求方法 | HTTP 方法。 允許的值為 POST (預設值)、PUT 和 PATCH。 | • POST • GET • PATCH |
No | requestMethod |
要求逾時 | 用來取得回應的 HTTP 要求的逾時 (時間範圍值)。 此值是取得回應的逾時值,而非讀取回應資料的逾時值。 預設值為 00:01:40。 | 時間範圍 | No | httpRequestTimeout |
要求間隔 (ms) | 對多個頁面的不同要求之間的間隔時間 (毫秒)。 要求間隔值應為介於 [10, 60000] 之間的數字。 | [10, 60000] | No | requestInterval |
寫入批次大小 | 每個批次寫入 REST 目的地的記錄數目。 預設值為 10000。 | <列數> (整數) |
No | writeBatchSize |
HTTP 壓縮類型 | 使用最佳壓縮等級傳送資料時使用的 HTTP 壓縮類型。 允許的值為無和 GZip。 | • 無 • GZip |
No | httpCompressionType |
其他標頭 | 其他 HTTP 要求標頭。 | <您的其他標頭> | No | additionalHeaders |