設定查詢字串參數

  • 發行項

適用於：所有 API 管理 層

set-query-parameter 原則會新增、取代值或刪除要求查詢字串參數。 可用來傳遞後端服務所需的查詢參數，為選擇性或從未存在於要求中。

注意

請依照原則陳述式中提供的順序，來設定原則的元素和子元素。 為了協助您設定此原則，入口網站會提供引導式表單型編輯器。 深入了解如何設定或編輯 APIM 原則。

原則陳述式

<set-query-parameter name="param name" exists-action="override | skip | append | delete">
    <value>value</value> <!--for multiple parameters with the same name add additional value elements-->
</set-query-parameter>

屬性

名字 描述 是必要欄位 預設
exists-action 指定在已指定查詢參數時要執行的動作。 此屬性必須具有下列其中一個值。

- override - 取代現有參數的值。
- skip - 不取代現有的查詢參數值。
- append - 將值附加至現有的查詢參數值。
- delete - 移除要求中的查詢參數。

設為 override 時，編列多個相同名稱的項目會導致根據所有項目來設定查詢參數 (列出多次)；只有列出的值才會設定在結果中。

允許使用原則運算式。		 No override
NAME 指定要設定之查詢參數的名稱。 允許使用原則運算式。 Yes N/A

元素

名稱 描述 必要
value 指定要設定的查詢參數值。 若多個查詢參數有相同名稱，請額外加入 value 元素。 允許使用原則運算式。 Yes

使用方式

範例

設定查詢參數的值


<set-query-parameter name="api-key" exists-action="skip">
  <value>12345678901</value>
</set-query-parameter>

設定查詢參數以將內容轉送至後端

這個範例示範如何在 API 層級套用，以提供後端服務的內容資訊。

<!-- Copy this snippet into the inbound element to forward a piece of context, product name in this example, to the backend service for logging or evaluation -->
<set-query-parameter name="x-product-name" exists-action="override">
  <value>@(context.Product.Name)</value>
</set-query-parameter>

如需詳細資訊，請參閱原則運算式和內容變數。

相關內容

如需使用原則的詳細資訊，請參閱：