반환 응답
적용 대상: 모든 API Management 계층
return-response
정책은 파이프라인 실행을 취소하고 호출자에게 기본 또는 사용자 지정된 응답을 반환합니다. 기본 응답은 본문 없는 200 OK
입니다. 컨텍스트 변수나 정책 문을 통해 사용자 지정 응답을 지정할 수 있습니다. 둘 다 제공되는 경우 컨텍스트 변수 내에 포함된 응답은 호출자로 반환하기 전에 정책 문으로 수정합니다.
참고 항목
정책 문에 제공된 순서대로 정책의 요소 및 자식 요소를 설정합니다. API Management 정책을 설정하거나 편집하는 방법에 대해 자세히 알아봅니다.
정책 문
<return-response response-variable-name="existing context variable">
<set-status>...</set-status>
<set-header>...</set-header>
<set-body>...</set-body>
</return-response>
특성
특성 | 설명 | 필수 항목 | 기본값 |
---|---|---|---|
response-variable-name | 참조하는 컨텍스트 변수 이름(예: 업스트림 send-request 정책 및 Response 개체 포함) 정책 식은 허용되지 않습니다. |
아니요 | 해당 없음 |
Elements
요소 | 설명 | 필수 |
---|---|---|
set-status | 응답의 상태 코드를 설정합니다. | 아니요 |
set-header | 응답에서 헤더를 설정합니다. | 아니요 |
set-body | 응답에서 본문을 설정합니다. | 아니요 |
사용
- 정책 섹션: inbound, outbound, backend, on-error
- 정책 범위: 전역, 작업 영역, 제품, API, 작업
- 게이트웨이: 클래식, v2, 사용량, 자체 호스팅, 작업 영역
사용법 참고 사항
- 리퀴드 템플릿은
return-response
정책의 본문(set-body
를 사용하여 설정) 내에 지정된 경우 작동하지 않습니다.return-response
정책은 현재 실행 파이프라인을 취소하고 현재 컨텍스트에서 요청 본문 및 응답 본문을 제거합니다. 결과적으로 정책 내에 지정된 liquid 템플릿은 빈 문자열을 입력으로 수신하고 예상 출력을 생성하지 않습니다.
예시
<return-response>
<set-status code="401" reason="Unauthorized"/>
<set-header name="WWW-Authenticate" exists-action="override">
<value>Bearer error="invalid_token"</value>
</set-header>
</return-response>
관련 정책
관련 콘텐츠
정책 작업에 대한 자세한 내용은 다음을 참조하세요.
- 자습서: API 변환 및 보호
- 정책 문 및 해당 설정에 대한 전체 목록에 대한 정책 참조
- 정책 식
- 정책 설정 또는 편집
- 정책 구성 재사용
- 정책 코드 조각 리포지토리
- Azure API Management 정책 도구 키트
- Azure의 Microsoft Copilot을 사용하는 작성자 정책