REST 엔드포인트 호출 태스크

REST 엔드포인트 호출 태스크를 사용하면 통합에서 모든 타사 REST API를 호출할 수 있습니다. REST API 호출의 응답은 통합 변수에서 사용할 수 있으며 다른 다운스트림 작업에서 사용할 수 있습니다.

시작하기 전에

  • REST API 호출의 인증 엔드포인트에 연결하려면 OAuth 2.0 프로필을 만들었거나 통합에 사용자 관리형 서비스 계정을 연결했는지 확인합니다. API에 인증이 필요하지 않으면 태스크 구성 창의 인증 프로필 필드를 비워 둘 수 있습니다. 구성 목록을 보려면 구성 속성을 참조하세요.

    통합에 OAuth 2.0 프로필과 사용자 관리형 서비스 계정이 모두 구성된 경우 기본적으로 OAuth 2.0 프로필이 인증에 사용됩니다. OAuth 2.0 프로필 또는 사용자 관리형 서비스 계정이 모두 구성되어 있지 않으면 실행이 실패합니다.

  • 통합에 서비스 계정이 연결된 경우 REST 엔드포인트 URL을 기반으로 필요한 IAM 역할을 해당 서비스 계정에 부여합니다. 예를 들어 REST 엔드포인트 URL이 Cloud Storage 서비스를 호출하는 경우 Cloud Storage 서비스에 필요한 IAM 역할을 부여합니다.

    서비스 계정에 역할 부여에 대한 자세한 내용은 서비스 계정에 대한 액세스 관리를 참조하세요.

  • Google Cloud 프로젝트에서 Apigee Integration에 VPC 서비스 제어가 설정되지 않았는지 확인합니다.

REST 엔드포인트 호출 태스크 구성

REST 엔드포인트 호출 태스크를 구성하려면 다음 안내를 따르세요.

  1. Apigee UI에서 Apigee 조직을 선택합니다.
  2. 개발 > 통합을 클릭합니다.
  3. 기존 통합을 선택하거나 통합 만들기를 클릭하여 새 통합을 만듭니다.

    새 통합을 만드는 경우:

    1. 통합 만들기 대화상자에 이름과 설명을 입력합니다.
    2. 지원되는 리전 목록에서 통합에 대한 리전을 선택합니다.
    3. 만들기를 클릭합니다.

    통합 디자이너 페이지에서 통합이 열립니다.

  4. 통합 설계자 탐색 메뉴에서 +태스크/트리거 추가 > 태스크를 클릭하여 사용 가능한 태스크 목록을 봅니다.
  5. 통합 편집기에서 REST 엔드포인트 호출 요소를 클릭하여 배치합니다.
  6. 디자이너에서 REST 엔드포인트 호출 요소를 클릭하여 호출 REST 엔드포인트 태스크 구성 창을 확인합니다.
  7. 다음 표의 설명대로 태스크의 구성 속성을 사용하여 표시된 필드를 구성합니다.

    속성 변경사항은 자동으로 저장됩니다.

구성 속성

다음 표에서는 REST 엔드포인트 호출 태스크의 구성 속성을 설명합니다.

속성 데이터 유형 Description(설명)
라벨 문자열 (선택사항) 태스크에 라벨을 추가합니다.
인증 문자열 (선택사항) 외부 시스템 연결을 위한 인증 세부정보를 구성하고 저장합니다. 자세한 내용은 Apigee Integration에서 인증 프로필 만들기를 참조하세요.
엔드포인트 기본 URL 문자열 쿼리 매개변수가 없는 REST 엔드포인트 URL입니다.
HTTP 메소드 해당 사항 없음 사용할 HTTP 메서드입니다.

다음 HTTP 메서드 중 하나를 선택할 수 있습니다.

  • DELETE
  • GET
  • HEAD
  • PATCH
  • POST
  • PUT
URL 쿼리 문자열 매개변수 쿼리 문자열 키: 문자열

값: 문자열

REST API 호출에 필요한 쿼리 매개변수입니다.

쿼리 매개변수는 키-값 쌍 형식이고 여기서 키는 키 이름이고 값은 해당하는 키 값입니다. 더하기 아이콘을 클릭하여 2개 이상의 키-값 쌍을 입력할 수 있습니다.

HTTP 헤더 HTTP 헤더 키: 문자열

값: 문자열

REST API 호출에 필요한 HTTP 헤더입니다.

HTTP 헤더는 키-값 쌍 형식이고 여기서 키는 키 이름이고 값은 해당하는 키 값입니다. 더하기 아이콘을 클릭하여 2개 이상의 키-값 쌍을 입력할 수 있습니다.

리디렉션 따르기 부울 URL 리디렉션을 따릅니다.

다음 값 중 하나를 선택할 수 있습니다.

  • True : 엔드포인트 기본 URL이 다른 URL로 전달된 경우 리디렉션된 URL을 호출합니다.
  • False: 엔드포인트 기본 URL이 다른 URL로 전달된 경우 리디렉션된 URL을 호출하지 않습니다.
HTTP 오류 발생 시 태스크가 실패합니다. 부울 REST API 호출이 실패할 경우의 예외 처리 전략입니다. HTTP 응답 코드가 4xx 또는 5xx이면 REST 엔드포인트 호출이 실패합니다. 오류 코드 목록은 오류 코드를 참조하세요. 다른 HTTP 응답 코드의 경우 응답에서 오류 코드와 오류 메시지를 반환합니다.

다음 값 중 하나를 선택할 수 있습니다.

  • True: 예외가 발생합니다.
  • False: 예외가 발생하지 않습니다. 그러나 응답에서 오류 코드와 오류 메시지를 반환합니다.
응답 헤어(<태스크 이름>) 문자열 REST API 응답에서 압축되지 않은 응답 헤더입니다.
응답 본문(<태스크 이름>) 문자열 REST API 응답에서 압축되지 않은 응답 본문입니다.
응답 상태(<Task name>) 문자열 HTTP 응답 코드와 REST API 응답의 해당 코드 텍스트입니다.

권장사항

REST 엔드포인트 호출 태스크에 적용되는 사용량 한도에 대한 자세한 내용은 사용량 한도를 참조하세요.

오류 처리 전략

태스크의 오류 처리 전략은 일시적인 오류로 인해 태스크가 실패할 경우 수행할 태스크를 지정합니다. 오류 처리 전략을 사용하는 방법과 다양한 유형의 오류 처리 전략에 대한 자세한 내용은 오류 처리 전략을 참조하세요.

4xx 또는 5xx 오류의 재시도 전략을 처리하는 방법은 응답 상태에 따라 REST 호출자 태스크를 재시도하는 방법 블로그를 참조하세요.