ListVirtualMachines
가상 머신을 나열합니다.
구문 요청
{
"HypervisorArn": "string
",
"MaxResults": number
,
"NextToken": "string
"
}
요청 파라미터
모든 작업에 공통되는 파라미터에 대한 자세한 설명은 공통 파라미터를 참조하세요.
요청은 JSON 형식으로 다음 데이터를 받습니다.
- HypervisorArn
-
가상 머신에 연결된 하이퍼바이저의 Amazon 리소스 이름(ARN)입니다.
유형: 문자열
길이 제약: 최소 길이는 50입니다. 최대 길이는 500입니다.
패턴:
^arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+$
Required: No
- MaxResults
-
나열할 최대 가상 머신 수입니다.
타입: 정수
유효 범위: 최소값 1.
필수 항목 여부: 아니요
- NextToken
-
반환된 리소스의 일부 목록 다음에 나오는 다음 항목입니다. 예를 들어, 리소스의
maxResults
수를 반환하기 위한 요청을 한 경우,NextToken
을 사용하면 다음 토큰이 가리키는 위치에서 시작하여 목록에 있는 추가 항목을 반환할 수 있습니다.유형: 문자열
길이 제약: 최소 길이는 1. 최대 길이는 1,000입니다.
패턴:
^.+$
필수 여부: 아니요
응답 구문
{
"NextToken": "string",
"VirtualMachines": [
{
"HostName": "string",
"HypervisorId": "string",
"LastBackupDate": number,
"Name": "string",
"Path": "string",
"ResourceArn": "string"
}
]
}
응답 요소
작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.
다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.
- NextToken
-
반환된 리소스의 일부 목록 다음에 나오는 다음 항목입니다. 예를 들어, 리소스의
maxResults
수를 반환하기 위한 요청을 한 경우,NextToken
을 사용하면 다음 토큰이 가리키는 위치에서 시작하여 목록에 있는 추가 항목을 반환할 수 있습니다.유형: 문자열
길이 제약: 최소 길이는 1. 최대 길이는 1,000입니다.
Pattern:
^.+$
- VirtualMachines
-
Amazon 리소스 이름(ARN) 순으로 정렬된
VirtualMachine
객체 목록입니다.타입: VirtualMachine 객체 배열
Errors
모든 작업에서 발생하는 일반적인 오류에 대한 자세한 내용은 일반적인 오류 섹션을 참조하세요.
- InternalServerException
-
내부 오류가 발생하여 작업에 성공하지 못했습니다. 나중에 다시 시도해 주십시오.
HTTP 상태 코드: 500
- ThrottlingException
-
TPS는 의도적이거나 의도하지 않은 대량 요청으로부터 보호하기 위해 제한되었습니다.
HTTP 상태 코드: 400
- ValidationException
-
검증 오류가 발생하여 작업에 성공하지 못했습니다.
HTTP 상태 코드: 400
참고
언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.