Apigee API 허브
Apigee API 허브 커넥터를 사용하면 조직 포트폴리오 내에서 API를 관리, 검색, 거버넌스할 수 있습니다.
지원되는 버전
이 커넥터는 Apigee API 허브 버전 v1을 지원합니다.
시작하기 전에
-
Google Cloud 프로젝트에서 다음 작업을 수행합니다.
- 네트워크 연결이 설정되어 있는지 확인합니다. 네트워크 패턴에 대한 자세한 내용은 네트워크 연결을 참조하세요.
- 커넥터를 구성하는 사용자에게 roles/connectors.admin IAM 역할을 부여합니다.
- 다음 서비스를 사용 설정합니다.
secretmanager.googleapis.com(Secret Manager API)connectors.googleapis.com(Connectors API)
서비스 사용 설정 방법은 서비스 사용 설정을 참조하세요. 이러한 서비스나 권한이 이전 프로젝트에서 사용 설정되지 않았으면 커넥터를 구성할 때 서비스나 권한을 사용 설정하라는 메시지가 표시됩니다.
- OAuth 2.0 인증 대신 서비스 계정 인증을 사용하는 경우 서비스 계정에 적절한 권한이 부여되었는지 확인합니다. 자세한 내용은 사전 정의된 IAM 역할을 참고하세요.
Apigee API 허브 연결 만들기
연결은 데이터 소스와 관련이 있습니다. 즉, 데이터 소스가 많으면 데이터 소스마다 별도의 연결을 만들어야 합니다. 연결을 만들려면 다음 단계를 따르세요.
- Cloud 콘솔에서 Integration Connectors > 연결 페이지로 이동한 다음 Google Cloud 프로젝트를 선택하거나 만듭니다.
- + 새로 만들기를 클릭하여 연결 만들기 페이지를 엽니다.
- 위치 섹션의 리전 목록에서 위치를 선택한 후 다음을 클릭합니다.
지원되는 모든 리전 목록은 위치를 참조하세요.
- 연결 세부정보 섹션에서 다음을 수행합니다.
- 커넥터 목록에서 Apigee API 허브를 선택합니다.
- 커넥터 버전 목록에서 커넥터 버전을 선택합니다.
- 연결 이름 필드에서 연결 인스턴스의 이름을 입력합니다. 연결 이름에는 소문자, 숫자 또는 하이픈을 사용할 수 있습니다. 이름은 문자로 시작하고 문자나 숫자로 끝나야 하며 이름은 49자를 초과해서는 안 됩니다.
- 선택적으로 연결 인스턴스에 대한 설명을 입력합니다.
- 필요한 경우 Cloud Logging을 사용 설정한 다음 로그 수준을 선택합니다. 기본적으로 로그 수준은
Error로 설정됩니다. - 서비스 계정: 필수 역할이 있는 서비스 계정을 선택합니다.
- (선택사항) 연결 노드 설정을 구성합니다.
- 최소 노드 수: 최소 연결 노드 수를 입력합니다.
- 최대 노드 수: 최대 연결 노드 수를 입력합니다.
- 다음을 클릭합니다.
노드는 트랜잭션을 처리하는 연결의 단위(또는 복제본)입니다. 연결에 대해 더 많은 트랜잭션을 처리하려면 더 많은 노드가 필요합니다. 이와 반대로 더 적은 트랜잭션을 처리하기 위해서는 더 적은 노드가 필요합니다. 노드가 커넥터 가격 책정에 미치는 영향을 파악하려면 연결 노드 가격 책정을 참고하세요. 값을 입력하지 않으면 기본적으로 최소 노드가 (높은 가용성을 위해) 2로 설정되고 최대 노드는 50으로 설정됩니다.
- 대상 섹션에서 연결하려는 원격 호스트(백엔드 시스템)의 세부정보를 입력합니다.
- 대상 유형 필드에서 대상을 선택합니다.
- 호스트 주소 필드에 대상의 호스트 이름이나 IP 주소를 지정합니다.
원하는 경우 +대상 추가를 클릭하여 추가 대상을 입력할 수 있습니다.
- 다음을 클릭합니다.
-
인증 섹션에서 인증 세부정보를 입력합니다.
- 인증 유형을 선택하고 관련 세부정보를 입력합니다.
Apigee API 허브 연결에서는 다음 인증 유형이 지원됩니다.
- OAuth 2.0 - 승인 코드
- 서비스 계정 인증
- 다음을 클릭합니다.
이러한 인증 유형을 구성하는 방법은 인증 구성을 참조하세요.
- 인증 유형을 선택하고 관련 세부정보를 입력합니다.
- 연결 및 인증 세부정보를 검토한 다음 만들기를 클릭합니다.
인증 구성
사용할 인증을 기반으로 세부정보를 입력합니다.
- OAuth 2.0 - 승인 코드: 웹 기반 사용자 로그인 흐름을 사용하여 인증하려면 이 옵션을 선택합니다. 다음 세부정보를 지정합니다.
- 클라이언트 ID: 백엔드 Apigee API 허브 서비스에 연결하는 데 필요한 클라이언트 ID입니다.
- 범위: 쉼표로 구분된 원하는 범위 목록입니다. 필요한 Google 서비스에 지원되는 모든 OAuth 2.0 범위를 보려면 Google API의 OAuth 2.0 범위 페이지의 관련 섹션을 참조하세요.
- 클라이언트 보안 비밀번호: Secret Manager 보안 비밀을 참조하세요. 이 승인을 구성하려면 먼저 Secret Manager 보안 비밀이 생성되어 있어야 합니다.
- 보안 비밀 버전: 클라이언트 보안 비밀번호에 대한 Secret Manager 보안 비밀 버전입니다.
-
서비스 계정 인증: 이 연결을 구성할 때 이전 단계에서 제공한 서비스 계정을 사용하여 인증하려면 이 옵션을 선택합니다. 인증에 필요한 관련 IAM 역할과 권한을 서비스 계정에 제공했는지 확인합니다.
- 범위: 드롭다운에서 필요한 OAuth 2.0 범위를 선택합니다. 자세한 내용은 액세스 범위를 참고하세요.
Authorization code 인증 유형의 경우 연결을 만든 후 연결을 승인해야 합니다.
연결 승인
OAuth 2.0 - 승인 코드를 사용하여 연결을 인증하는 경우 연결을 만든 후 다음 작업을 완료합니다.
- 연결 페이지에서 새로 만든 연결을 찾습니다.
새 커넥터의 상태는 승인 필요입니다.
- 승인 필요를 클릭합니다.
그러면 승인 수정 창이 표시됩니다.
- 리디렉션 URI 값을 외부 애플리케이션에 복사합니다.
- 승인 세부정보를 확인합니다.
- 승인을 클릭합니다.
승인이 성공하면 연결 페이지에서 연결 상태가 활성으로 설정됩니다.
승인 코드 재승인
Authorization code 인증 유형을 사용하고 있고 Apigee API 허브에서 구성을 변경한 경우에는 Apigee API 허브 연결을 다시 승인해야 합니다. 연결을 다시 승인하려면 다음 단계를 수행하세요.
시스템 제한사항
Apigee API 허브 커넥터는 노드당 1초에 최대 20개의 트랜잭션을 처리할 수 있으며, 이 한도를 초과하는 모든 트랜잭션을 제한합니다. 기본적으로 Integration Connectors는 가용성을 높이기 위해 연결에 2개의 노드를 할당합니다.
Integration Connectors에 적용되는 한도에 대한 자세한 내용은 한도를 참조하세요.
통합에서 Apigee API 허브 연결 사용
연결을 만들면 Application Integration에서 사용할 수 있게 됩니다. 커넥터 태스크를 통해 통합에서 연결을 사용할 수 있습니다.
작업
이 커넥터는 연결된 백엔드 서비스 객체에 대한 추상화 레이어를 제공합니다. 이 추상화를 통해서만 백엔드 객체에 액세스할 수 있습니다. 추상화는 작업으로 노출됩니다. Action은 커넥터 인터페이스를 통해 통합에 제공되는 첫 번째 클래스 함수입니다. 작업을 사용하면 항목을 변경할 수 있으며 작업은 커넥터마다 다릅니다. 하지만 커넥터에서 작업을 지원하지 않을 수 있으며 이 경우 Actions 목록이 비어 있습니다.
알려진 문제
Apigee API 허브 커넥터에는 구성 한도가 있습니다. 검색 가능한 리소스는 2.5MB로 제한되며 API 사양 파일은 10MB로 제한됩니다. 자세한 내용은 Apigee API 허브의 한도를 참고하세요.
Google Cloud 커뮤니티에서 도움 받기
Google Cloud 커뮤니티에서 Cloud 포럼에 질문을 게시하고 이 커넥터에 대해 토론할 수 있습니다.
다음 단계
- 연결 일시중지 및 재개 방법 알아보기
- 커넥터 사용량 모니터링 방법 알아보기
- 커넥터 로그 확인 방법 알아보기