ListServers - AWS Transfer Family
구문 요청요청 파라미터응답 구문Response ElementsErrors예시참고

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

ListServers

AWS 계정과 연결된 파일 전송 프로토콜 지원 서버를 나열합니다.

구문 요청

{
   "MaxResults": number,
   "NextToken": "string"
}

요청 파라미터

모든 작업에 공통되는 파라미터에 대한 내용은 공통 파라미터를 참조하십시오.

요청은 JSON 형식의 다음 데이터를 수락합니다.

MaxResults

ListServers 쿼리에 대한 응답으로 반환할 서버 수를 지정합니다.

타입: 정수

유효한 범위: 최소값은 1입니다. 최대값은 1000입니다.

필수 여부: 아니요

NextToken

ListServers 명령에서 추가 결과를 얻으면 출력에 NextToken 파라미터가 반환됩니다. 그런 다음 후속 명령에 NextToken 파라미터를 전달하여 추가 서버를 계속 나열할 수 있습니다.

타입: 문자열

길이 제약 조건: 최소 길이는 1입니다. 최대 길이는 6144입니다.

필수 여부: 아니요

응답 구문

{
   "NextToken": "string",
   "Servers": [ 
      { 
         "Arn": "string",
         "Domain": "string",
         "EndpointType": "string",
         "IdentityProviderType": "string",
         "LoggingRole": "string",
         "ServerId": "string",
         "State": "string",
         "UserCount": number
      }
   ]
}

Response Elements

작업이 성공하면 서비스가 HTTP 200개의 응답을 다시 보냅니다.

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

NextToken

ListServers 작업에서 추가 결과를 얻을 수 있는 경우 출력에 NextToken 파라미터가 반환됩니다. 다음 명령에서 NextToken 파라미터를 전달하여 추가 서버를 계속 나열할 수 있습니다.

타입: 문자열

길이 제약 조건: 최소 길이는 1입니다. 최대 길이는 6144입니다.

Servers

나열된 서버 배열입니다.

타입: ListedServer 객체 배열

Errors

모든 작업에 공통되는 오류에 대한 내용은 일반적인 오류 섹션을 참조하십시오.

InternalServiceError

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

HTTP 상태 코드: 500

InvalidNextTokenException

전달된 NextToken 파라미터가 유효하지 않습니다.

HTTP 상태 코드: 400

InvalidRequestException

이 예외는 클라이언트가 잘못된 형식의 요청을 제출할 때 던져집니다.

HTTP 상태 코드: 400

ServiceUnavailableException

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

HTTP 상태 코드: 500

예시

예

다음 예제에서는 에 있는 서버를 나열합니다 AWS 계정.

참고로, 예의 NextToken 값은 실제 값이 아닙니다. 이 값은 파라미터 사용 방법을 나타내기 위한 것입니다.

샘플 요청

{
   "MaxResults": 1,
   "NextToken": "token-from-previous-API-call"
}

샘플 응답

{
   "NextToken": "another-token-to-continue-listing",
   "Servers": [
      {
         "Arn": "arn:aws:transfer:us-east-1:111112222222:server/s-01234567890abcdef",
         "Domain": "S3",
         "IdentityProviderType": "SERVICE_MANAGED",
         "EndpointType": "PUBLIC",
         "LoggingRole": "arn:aws:iam::111112222222:role/my-role",
         "ServerId": "s-01234567890abcdef",
         "State": "ONLINE",
         "UserCount": 3
      }
   ]
}

참고

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