DescribeHostKey - AWS Transfer Family
구문 요청요청 파라미터응답 구문응답 요소Errors참고

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

DescribeHostKey

HostKeyId 및 ServerId에 의해 지정된 호스트 키의 세부 정보를 반환합니다.

구문 요청

{
   "HostKeyId": "string",
   "ServerId": "string"
}

요청 파라미터

모든 작업에서 사용하는 파라미터에 대한 자세한 내용은 범용 파라미터를 참조하세요.

요청은 JSON 형식으로 다음 데이터를 받습니다.

HostKeyId

설명하려는 호스트 키의 식별자입니다.

타입: 문자열

길이 제약 조건: 고정 길이는 25입니다.

패턴: hostkey-[0-9a-f]{17}

필수 사항 여부: Yes

ServerId

설명하려는 호스트 키가 들어 있한 서버의 식별자입니다.

타입: 문자열

길이 제약 조건: 고정 길이는 19입니다.

패턴: s-([0-9a-f]{17})

필수 항목 여부: 예

응답 구문

{
   "HostKey": { 
      "Arn": "string",
      "DateImported": number,
      "Description": "string",
      "HostKeyFingerprint": "string",
      "HostKeyId": "string",
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "Type": "string"
   }
}

응답 요소

작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.

다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.

HostKey

지정된 호스트 키의 세부 정보를 반환합니다.

타입: DescribedHostKey 객체

Errors

모든 작업에서 발생하는 일반적인 오류에 대한 자세한 내용은 일반적인 오류 섹션을 참조하세요.

InternalServiceError

이 예외는 AWS Transfer Family 서비스에 오류가 발생할 때 발생합니다.

HTTP 상태 코드: 500

InvalidRequestException

클라이언트가 잘못된 형식의 요청을 제출하면 이 예외가 발생합니다.

HTTP 상태 코드: 400

ResourceNotFoundException

AWS Transfer Family 서비스에서 리소스를 찾을 수 없는 경우 이 예외가 발생합니다.

HTTP 상태 코드: 400

ServiceUnavailableException

AWS Transfer Family 서비스를 이용할 수 없어 요청이 실패했습니다.

HTTP 상태 코드: 500

참고

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.