SFTP

SFTP 커넥터를 사용하면 SFTP 서버에 연결하고 파일 전송 작업을 수행할 수 있습니다.

시작하기 전에

Google Cloud 프로젝트에서 다음 작업을 수행합니다.

• 네트워크 연결이 설정되어 있는지 확인합니다. 자세한 내용은 네트워크 연결을 참고하세요.
• 커넥터를 구성하는 사용자에게 roles/connectors.admin IAM 역할을 부여합니다.
• 커넥터에 사용할 서비스 계정에 roles/secretmanager.viewer 및 roles/secretmanager.secretAccessor IAM 역할을 부여합니다. 서비스 계정이 없으면 서비스 계정을 만들어야 합니다. 커넥터와 서비스 계정은 동일한 프로젝트에 속해야 합니다.
• secretmanager.googleapis.com (Secret Manager API) 및 connectors.googleapis.com (Connectors API)를 사용 설정합니다. 자세한 내용은 서비스 사용 설정을 참고하세요.

SFTP 연결 만들기

연결은 데이터 소스와 관련이 있습니다. 즉, 데이터 소스가 많으면 데이터 소스마다 별도의 연결을 만들어야 합니다. 연결을 만들려면 다음 단계를 따르세요.

1. Cloud 콘솔에서 Integration Connectors > 연결 페이지로 이동한 다음 Google Cloud 프로젝트를 선택하거나 만듭니다.

   연결 페이지로 이동

2. + 새로 만들기를 클릭하여 연결 만들기 페이지를 엽니다.
3. 위치 섹션의 리전 목록에서 위치를 선택한 후 다음을 클릭합니다.

   지원되는 모든 리전 목록은 위치를 참조하세요.

4. 연결 세부정보 섹션에서 다음을 완료합니다.
   1. 커넥터 필드에서 SFTP를 선택합니다.
   2. 커넥터 버전 필드에서 원하는 버전을 선택합니다.
   3. 연결 이름 필드에서 연결 인스턴스의 이름을 입력합니다. 연결 이름에는 소문자, 숫자, 하이픈을 사용할 수 있습니다. 이름은 문자로 시작하고 문자나 숫자로 끝나야 하며 이름은 49자를 초과해서는 안 됩니다.
   4. 선택적으로 연결 인스턴스에 대한 설명을 입력합니다.
   5. 필요한 경우 Cloud Logging을 사용 설정한 다음 로그 수준을 선택합니다. 기본적으로 로그 수준은 Error로 설정됩니다.
   6. 서비스 계정 필드에서 필수 역할이 있는 계정을 선택합니다.
   7. (선택사항) 연결 노드 설정을 구성합니다.
   • 최소 노드 수: 최소 연결 노드 수를 입력합니다.
   • 최대 노드 수: 최대 연결 노드 수를 입력합니다.

   노드는 트랜잭션을 처리하는 연결의 단위(또는 복제본)입니다. 연결에 대해 더 많은 트랜잭션을 처리하려면 더 많은 노드가 필요합니다. 이와 반대로 더 적은 트랜잭션을 처리하기 위해서는 더 적은 노드가 필요합니다. 노드가 커넥터 가격 책정에 미치는 영향을 파악하려면 연결 노드 가격 책정을 참고하세요. 값을 입력하지 않으면 기본적으로 최소 노드가 (높은 가용성을 위해) 2로 설정되고 최대 노드는 50으로 설정됩니다.

   참고: 사용한 만큼만 지불 고객인 경우에만 연결 노드 값을 맞춤설정할 수 있습니다.
   8. (선택사항) 원격 경로 필드에 SFTP 서버의 폴더 경로를 입력하여 List, Create, Update, Delete과 같은 엔티티 작업을 실행합니다.

   루트 폴더 또는 루트 폴더의 직속 하위 폴더에 있는 항목 (파일 또는 폴더)에 액세스하는 경우에는 이 필드에 값을 설정할 필요가 없습니다. 그러나 루트 폴더에서 2단계 이상의 수준에 있는 중첩 항목에 액세스하려면 이 필드의 값을 액세스하려는 항목이 있는 폴더의 기본 경로로 설정해야 합니다. 예를 들어 /folder_A/folder_B/folder_C/test.png 파일에 액세스하려면 원격 경로를 /folder_A/folder_B/folder_C로 설정해야 합니다.

   9. 선택적으로 + 라벨 추가를 클릭하여 키/값 쌍의 형식으로 연결에 라벨을 추가합니다.
   10. 다음을 클릭합니다.
5. 대상 섹션에서 연결하려는 원격 호스트 (백엔드 시스템)의 세부정보를 입력하고 다음을 클릭합니다.

대상 유형 필드에서 원하는 유형을 선택합니다.

• 대상 호스트 이름 또는 IP 주소를 지정하려면 호스트 주소를 선택하고 호스트 1 필드에 주소를 입력합니다.
• 비공개 연결을 설정하려면 엔드포인트 연결을 선택하고 엔드포인트 연결 목록에서 필요한 연결을 선택합니다.
  참고: 엔드포인트 연결을 만드는 방법은 PSC 서비스 연결 및 엔드포인트 연결을 참조하세요. 엔드포인트 연결을 만들면 엔드포인트 연결 목록에 표시됩니다.

추가 보안을 사용하여 백엔드 시스템에 공개 연결을 설정하려면 연결의 고정 아웃바운드 IP 주소를 구성한 후 방화벽 규칙을 구성하여 특정 고정 IP 주소만 허용 목록에 추가합니다.

6. 인증 섹션에서 인증 유형을 선택하고 관련 세부정보를 입력한 후 다음을 클릭합니다.

   SFTP 연결에서는 다음 인증 유형이 지원됩니다.

   • 사용자 이름 및 비밀번호
   • SSH_PUBLIC_KEY

   이러한 인증 유형을 구성하는 방법은 인증 구성을 참고하세요.

7. 연결 및 인증 세부정보를 검토한 다음 만들기를 클릭합니다.

인증 구성

사용할 인증을 기반으로 세부정보를 입력합니다.

• 사용자 이름 및 비밀번호
  • 사용자 이름: 연결에 사용할 SFTP 사용자 이름입니다.
  • 비밀번호: SFTP 사용자 이름과 연결된 비밀번호가 포함된 Secret Manager 보안 비밀입니다.

• SSH_PUBLIC_KEY
  • 사용자 이름: 인증에 사용된 SFTP 사용자 계정입니다.
  • SSH 비공개 키: SSH 인증을 위한 비공개 키입니다.
  • SSH 비공개 키 비밀번호: 비공개 키를 보호하는 암호/비밀번호입니다.
  • SSH 비공개 키 유형: 비공개 키의 형식입니다.

통합에서 SFTP 연결 사용

연결을 만들면 Apigee Integration 및 Application Integration에서 사용할 수 있게 됩니다. 커넥터 태스크를 통해 통합에서 연결을 사용할 수 있습니다.

• Apigee Integration에서 커넥터 태스크를 만들고 사용하는 방법을 알아보려면 커넥터 태스크를 참조하세요.
• Application Integration에서 커넥터 태스크를 만들고 사용하는 방법을 이해하려면 커넥터 태스크를 참조하세요.

작업

이 섹션에는 커넥터가 지원하는 작업 중 일부가 나와 있습니다. 작업을 구성하는 방법은 작업 예시를 참조하세요.

참고: 모든 작업 결과는 통합을 실행한 후 Connectors 태스크의 connectorOutputPayload 응답 매개변수에서 JSON 응답으로 제공됩니다.

Upload 작업

다음 표에서는 Upload 작업의 입력 매개변수를 설명합니다.

파라미터 이름	데이터 유형	필수	설명
콘텐츠	문자열	아니요	파일로 업로드할 콘텐츠입니다.
ContentBytes	문자열	아니요	Base64 문자열 형식의 바이트 콘텐츠를 파일로 업로드합니다. 바이너리 데이터를 업로드하는 데 사용합니다.
HasBytes	불리언	아니요	콘텐츠를 바이트로 업로드할지 여부를 지정합니다. 기본값은 false입니다.
RemoteFile	문자열	예	원격 호스트의 파일 이름입니다.
덮어쓰기	불리언	아니요	원격 파일을 덮어쓸지 여부를 지정합니다. 기본값은 false입니다.

Upload 작업을 구성하는 방법의 예시는 예시를 참조하세요.

Download 작업

다음 표에서는 Download 작업의 입력 매개변수를 설명합니다.

파라미터 이름	데이터 유형	필수	설명
RemoteFile	문자열	예	원격 호스트의 파일 이름입니다.
HasBytes	불리언	아니요	콘텐츠를 바이트로 다운로드할지 여부를 지정합니다. 기본값은 false입니다.

Download 작업을 구성하는 방법의 예시는 예시를 참조하세요.

MoveFile 작업

다음 표에서는 MoveFile 작업의 입력 매개변수를 설명합니다.

파라미터 이름	데이터 유형	필수	설명
RemoteFile	문자열	예	이동할 원격 파일의 경로입니다.
DestinationPath	문자열	예	파일을 이동할 새 경로입니다.

MoveFile 작업을 구성하는 방법의 예시는 예시를 참조하세요.

RenameFile 작업

다음 표에서는 RenameFile 작업의 입력 매개변수를 설명합니다.

파라미터 이름	데이터 유형	필수	설명
RemoteFile	문자열	예	이름을 바꿀 원격 파일 경로 및 이름입니다.
NewFileName	문자열	예	원격 파일의 새 이름입니다.

RenameFile 작업을 구성하는 방법의 예시는 예시를 참조하세요.

예시

이 섹션에서는 이 커넥터에서 일부 항목 작업과 조치를 수행하는 방법을 설명합니다. 이 예시에서는 다음 작업을 설명합니다.

• 루트 디렉터리에 있는 모든 파일 나열
• 디렉터리의 패턴과 일치하는 파일 나열
• 파일 이동
• 파일 이름 변경
• 파일 삭제
• ASCII 텍스트 파일 업로드
• 바이너리 파일 업로드
• ASCII 텍스트 파일 다운로드
• 바이너리 파일 다운로드
• 여러 파일 다운로드

다음 표에는 샘플 시나리오와 커넥터 태스크의 해당 구성이 나와 있습니다.

작업	명령어 샘플	구성
루트 디렉터리에 있는 모든 파일 나열	ls /	Configure connector task 대화상자에서 Entities를 클릭합니다. Root 항목을 선택한 후 List 작업을 선택합니다. 완료를 클릭합니다.
디렉터리의 .csv 파일 나열	ls /tmp/*.csv	Configure connector task 대화상자에서 Entities를 클릭합니다. Entity 목록에서 기본 디렉터리(/tmp)를 선택합니다. List 작업을 선택한 후 완료를 클릭합니다. 필터 절을 설정합니다. 절을 설정하려면 커넥터 태스크의 태스크 입력 섹션에서 filterClause를 클릭한 다음 기본값 필드에 FilePath LIKE '/tmp/%.csv'를 입력합니다. 참고: 필터 절의 파일 패턴 값은 작은따옴표(')로 묶어야 합니다. Entity 목록에는 기본 수준 디렉터리만 표시됩니다. 따라서 기본 수준 디렉터리에만 있는 파일을 나열할 수 있습니다. 하위 디렉터리의 파일 나열은 지원되지 않습니다. FilePath 필드는 입력 페이로드의 JSON 스키마에 정의됩니다. 사용 가능한 모든 필드 목록은 페이로드의 JSON 스키마를 참고하세요. 통합에서 데이터 매핑 태스크를 사용하여 필터 절을 동적으로 설정할 수 있습니다.
파일 이동	mv /tmp/dir_A/hello_world.txt /dir_B/dir_C/	Configure connector task 대화상자에서 Actions를 클릭합니다. MoveFile 조치를 선택한 다음 완료를 클릭합니다. 커넥터 태스크의 태스크 입력 섹션에서 connectorInputPayload를 클릭한 후 Default Value 필드에 다음과 유사한 값을 입력합니다. { "RemoteFile": "/tmp/dir_A/hello_world.txt", "DestinationPath": "/dir_B/dir_C/" } 이 예시에서는 /tmp/dir_A/hello_world.txt 파일을 /dir_B/dir_C/ 디렉터리로 이동합니다. 이 예시를 실행하면 커넥터 태스크의 connectorOutputPayload 출력 변수에서 다음과 비슷한 응답이 반환됩니다. [{ "Success":"true" }]
파일 이름 변경	mv /tmp/hello_world.txt /tmp/hello_world_new.txt	Configure connector task 대화상자에서 Actions를 클릭합니다. RenameFile 조치를 선택한 다음 완료를 클릭합니다. 커넥터 태스크의 태스크 입력 섹션에서 connectorInputPayload를 클릭한 후 Default Value 필드에 다음과 유사한 값을 입력합니다. { "RemoteFile": "/tmp/hello_world.txt", "NewFilename": "hello_world_new.txt" } 이 예시에서는 hello_world.txt 파일 이름을 hello_world_new.txt로 바꿉니다. 이 예시를 실행하면 커넥터 태스크의 connectorOutputPayload 출력 변수에서 다음과 비슷한 응답이 반환됩니다. [{ "Success":"true" }]
파일 삭제	rm /tmp/myfile.csv	Configure connector task 대화상자에서 Entities를 클릭합니다. Entity 목록에서 이동할 파일이 있는 기본 디렉터리를 선택합니다. Delete 작업을 선택한 후 완료를 클릭합니다. 항목 ID를 파일의 전체 경로로 설정합니다. 항목 ID를 설정하려면 커넥터 태스크의 태스크 입력 섹션에서 entityId를 클릭한 다음 기본값 필드에 /tmp/myfile.csv를 입력합니다. 또는 entityId를 지정하는 대신 filterClause를 FilePath LIKE '/tmp/myfile.csv'로 설정할 수도 있습니다.
ASCII 텍스트 파일 업로드	put file_1.txt /tmp/file_1.txt	Configure connector task 대화상자에서 Actions를 클릭합니다. Upload 조치를 선택한 다음 완료를 클릭합니다. 커넥터 태스크의 태스크 입력 섹션에서 connectorInputPayload를 클릭한 다음 Default Value 필드에 다음을 입력합니다. { "Content": "This is a sample text!\r\n", "RemoteFile": "/tmp/file_1.txt", "Overwrite": true } 이 샘플에서는 SFTP 서버의 /tmp 디렉터리에 This is a sample text! 콘텐츠가 있는 file_1.txt 파일을 만듭니다. Overwrite 속성 값이 true이므로 이름이 동일한 기존 파일은 덮어써집니다. Overwrite 속성 설정은 선택사항입니다. 기본값은 false입니다. 참고: 로컬 파일은 SFTP 서버에 직접 업로드할 수 없습니다. Content 속성에 파일의 전체 콘텐츠를 지정해야 합니다.
바이너리 파일 업로드	put image_1.png /tmp/image_1.png	바이너리 콘텐츠를 업로드하려면 먼저 콘텐츠를 Base64 형식으로 인코딩해야 합니다. 원하는 도구를 선택하여 콘텐츠를 인코딩할 수 있습니다. 콘텐츠 인코딩 단계는 이 문서에서 다루지 않습니다. 콘텐츠를 Base64 문자열로 인코딩한 후 다음 단계를 수행합니다. Configure connector task 대화상자에서 Actions를 클릭합니다. Upload 조치를 선택한 다음 완료를 클릭합니다. 커넥터 태스크의 태스크 입력 섹션에서 connectorInputPayload를 클릭한 다음 Default Value 필드에 다음을 입력합니다. { "ContentBytes": "SGVsbG8gd29ybGQ=", "RemoteFile": "/tmp/image_1.png", "Overwrite": true, "HasBytes": true } 이 샘플은 ContentBytes 필드에 지정된 콘텐츠로 image_1.png 파일을 만듭니다. 파일은 SFTP 서버의 /tmp 디렉터리에 생성됩니다. Overwrite 속성 값이 true이므로 이름이 동일한 기존 파일은 덮어써집니다. Overwrite 속성 설정은 선택사항입니다. 기본값은 false입니다.
ASCII 텍스트 파일 다운로드	get /tmp/myfile.txt	Configure connector task 대화상자에서 Actions를 클릭합니다. Download 조치를 선택한 다음 완료를 클릭합니다. 커넥터 태스크의 태스크 출력 섹션에서 connectorInputPayload를 클릭한 다음 Default Value 필드에 다음을 입력합니다. { "RemoteFile": "/tmp/myfile.txt" } 다운로드한 파일의 콘텐츠는 커넥터 태스크의 connectorOutputPayload 응답 매개변수의 Content 필드에 문자열로 제공됩니다.
바이너리 파일 다운로드	get /tmp/myfile.png	Configure connector task 대화상자에서 Actions를 클릭합니다. Download 조치를 선택한 다음 완료를 클릭합니다. 커넥터 태스크의 태스크 출력 섹션에서 connectorInputPayload를 클릭한 다음 Default Value 필드에 다음을 입력합니다. { "RemoteFile": "/tmp/myfile.png", "HasBytes" : true } 다운로드한 파일의 콘텐츠는 커넥터 태스크의 connectorOutputPayload 응답 매개변수의 ContentBytes 필드에서 Base64로 인코딩된 문자열로 제공됩니다.
여러 파일 다운로드		Configure connector task 대화상자에서 Actions를 클릭합니다. Download 조치를 선택한 다음 완료를 클릭합니다. 커넥터 태스크의 태스크 출력 섹션에서 connectorInputPayload를 클릭한 다음 Default Value 필드에 다음을 입력합니다. { "RemoteFile": "/tmp/myfile*.txt" }

시스템 제한사항

SFTP 커넥터는 노드당 1초에 1개의 트랜잭션을 처리할 수 있으며 이 한도를 초과하는 트랜잭션을 제한합니다. 기본적으로 Integration Connectors는 가용성을 높이기 위해 연결에 2개의 노드를 할당합니다.

Integration Connectors에 적용되는 한도에 대한 자세한 내용은 한도를 참조하세요.

참고: Integration Connectors 노드 수는 사용량에 따라 동적으로 자동 확장됩니다. 하지만 자동 확장을 기다리지 않고 대용량을 예약하려면 연결의 최소 노드 값을 조정하면 됩니다. 연결에 대해 더 많은 트랜잭션을 처리하려면 더 많은 노드가 필요합니다. 이와 반대로 더 적은 트랜잭션을 처리하려면 더 적은 노드가 필요합니다. 노드 값을 구성하려면 다음 안내를 따르세요.

• 사용한 만큼만 지불 고객인 경우 연결 수정 페이지에서 최소 및 최대 노드 값을 구성합니다.
• 정기 결제 기반 고객인 경우 지원팀에 문의하세요.

노드에서 처리할 수 있는 최대 트랜잭션은 다양한 요소에 따라 달라집니다. 따라서 처리량을 늘리기 위해 최소 노드를 조정하기 전에 백엔드 시스템이 필요한 트래픽을 처리하도록 최적으로 설정되었는지 확인하는 것이 좋습니다.

Terraform을 사용하여 연결 만들기

Terraform 리소스를 사용하여 새 연결을 만들 수 있습니다.

Terraform 구성을 적용하거나 삭제하는 방법은 기본 Terraform 명령어를 참조하세요.

연결 만들기를 위한 샘플 Terraform 템플릿을 보려면 샘플 템플릿을 참조하세요.

Terraform을 사용하여 이 연결을 만들 때는 Terraform 구성 파일에서 다음 변수를 설정해야 합니다.

매개변수 이름	데이터 유형	필수	설명
remote_path	STRING	False	SFTP 서버의 현재 경로입니다.

페이로드의 JSON 스키마

SFTP 연결의 모든 항목 객체에는 사전 정의된 JSON 스키마가 있습니다. SFTP 연결의 항목 객체는 다음 JSON 스키마를 사용합니다.

    {
      "type": "object",
      "properties": {
        "FilePath": {
          "type": "string",
          "readOnly": false
        },
        "Filename": {
          "type": [
            "string",
            "null"
          ],
          "readOnly": false,
          "description": "The name of the file or directory."
        },
        "FileSize": {
          "type": [
            "number",
            "null"
          ],
          "readOnly": false,
          "description": "The size of the file."
        },
        "LastModified": {
          "type": [
            "string",
            "null"
          ],
          "readOnly": false
        },
        "IsDirectory": {
          "type": [
            "boolean",
            "null"
          ],
          "readOnly": false
        },
        "Permissions": {
          "type": [
            "string",
            "null"
          ],
          "readOnly": false
        },
        "Owner": {
          "type": [
            "string",
            "null"
          ],
          "readOnly": false
        },
        "OwnerId": {
          "type": [
            "string",
            "null"
          ],
          "readOnly": false
        },
        "Group": {
          "type": [
            "string",
            "null"
          ],
          "readOnly": false
        },
        "GroupId": {
          "type": [
            "string",
            "null"
          ],
          "readOnly": false
        }
      }
    }
  

Google Cloud 커뮤니티에서 도움 받기

Google Cloud 커뮤니티에서 Cloud 포럼에 질문을 게시하고 이 커넥터에 대해 토론할 수 있습니다.

다음 단계

• 연결 일시중지 및 재개 방법 알아보기
• 커넥터 사용량 모니터링 방법 알아보기
• 커넥터 로그 확인 방법 알아보기