기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.
TestConnection
SFTP 커넥터가 성공적으로 설정되었는지 테스트합니다. 로컬 AWS 스토리지와 거래 파트너의 SFTP 서버 간에 파일을 전송할 수 있는지 테스트하려면 이 작업을 호출하는 것이 좋습니다.
구문 요청
{
"ConnectorId": "string
"
}
요청 파라미터
모든 작업에 공통되는 파라미터에 대한 자세한 설명은 공통 파라미터를 참조하세요.
요청은 JSON 형식으로 다음 데이터를 받습니다.
- ConnectorId
-
커넥터의 고유 식별자입니다.
타입: 문자열
길이 제약 조건: 고정 길이는 19입니다.
패턴:
c-([0-9a-f]{17})
필수 여부: 예
응답 구문
{
"ConnectorId": "string",
"Status": "string",
"StatusMessage": "string"
}
응답 요소
작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.
다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.
- ConnectorId
-
테스트 중인 커넥터 객체의 식별자를 반환합니다.
타입: 문자열
길이 제약 조건: 고정 길이는 19입니다.
패턴:
c-([0-9a-f]{17})
- Status
-
테스트 성공 시
OK
또는 테스트 실패 시ERROR
를 반환됩니다.타입: 문자열
- StatusMessage
-
테스트가 성공한 경우
Connection succeeded
를 반환합니다. 또는 테스트 실패 시 설명이 포함된 오류 메시지를 반환합니다. 다음 목록은 표시되는 오류 메시지에 따른 문제 해결 세부 정보를 제공합니다.-
암호 이름이 역할 전송 권한의 이름과 일치하는지 확인하세요.
-
커넥터 구성에서 서버 URL을 확인하고 로그인 자격 증명이 커넥터 외부에서 제대로 작동하는지 확인합니다.
-
암호가 존재하고 형식이 올바른지 확인하세요.
-
커넥터 구성의 신뢰 호스트 키가
ssh-keyscan
출력과 일치하는지 확인하세요.
타입: 문자열
-
Errors
모든 작업에 공통되는 오류에 대한 내용은 일반적인 오류 섹션을 참조하십시오.
- InternalServiceError
-
이 예외는 서비스에 오류가 발생할 때 발생합니다. AWS Transfer Family
HTTP 상태 코드: 500
- InvalidRequestException
-
이 예외는 클라이언트가 잘못된 형식의 요청을 제출할 때 던져집니다.
HTTP 상태 코드: 400
- ResourceNotFoundException
-
AWS Transfer Family 서비스에서 리소스를 찾을 수 없는 경우 이 예외가 발생합니다.
HTTP 상태 코드: 400
- ServiceUnavailableException
-
AWS Transfer Family 서비스를 이용할 수 없어 요청이 실패했습니다.
HTTP 상태 코드: 500
예
예
다음 예에서는 원격 서버와의 연결을 테스트합니다.
aws transfer test-connection --connector-id c-abcd1234567890fff
샘플 응답
성공하면 API 호출은 다음 세부 정보를 반환합니다.
{ "Status": "OK", "StatusMessage": "Connection succeeded" }
참고
언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.