쿼리 문자열 매개 변수 설정

  • 아티클

적용 대상: 모든 API Management 계층

set-query-parameter 정책은 요청 쿼리 문자열 매개 변수의 추가, 값 바꾸기 또는 삭제를 수행합니다. 백 엔드 서비스에 필요한 쿼리 매개 변수를 전달하는 데 사용하며, 이러한 매개 변수는 선택적이거나 요청에 절대로 존재하지 않습니다.

참고 항목

정책 문에 제공된 순서대로 정책의 요소 및 자식 요소를 설정합니다. 이 정책을 구성하는 데 도움이 되도록 포털은 양식 기반의 안내형 편집기를 제공합니다. API Management 정책을 설정하거나 편집하는 방법에 대해 자세히 알아봅니다.

정책 문

<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로 설정할 때 동일한 이름의 여러 항목을 등록하면 모든 항목(여러 번 나열됨)에 따라 쿼리 매개 변수가 설정되며, 나열된 값만 결과에 설정됩니다.

정책 식이 허용됩니다.		 아니요 override
name 설정할 쿼리 매개 변수의 이름을 지정합니다. 정책 식이 허용됩니다. 예 해당 없음

Elements

이름 설명 필수
value 설정할 조회 매개 변수의 값을 지정합니다. 동일한 이름을 가진 여러 쿼리 매개 변수에 대해서는 추가 value 요소를 추가합니다. 정책 식이 허용됩니다. 예

사용

예제

쿼리 매개 변수 값 설정


<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>

자세한 내용은 정책 식 및 컨텍스트 변수를 참조하세요.

관련 콘텐츠

정책 작업에 대한 자세한 내용은 다음을 참조하세요.