기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.
# DescribeServers
하나 이상의 Amazon DCV 서버를 설명합니다.
**Topics**
+ [
## 요청 파라미터
](#request)
+ [
## 응답 파라미터
](#response)
+ [
## 예제
](#example)
## 요청 파라미터
**`ServerIds`**
설명해야 할 Amazon DCV 서버의 ID입니다. ID가 지정되지 않으면 모든 서버가 페이지 매김 출력으로 반환됩니다.
유형: 문자열 배열
필수 여부: 아니요
**`NextToken`**
결과의 다음번 페이지를 가져오기 위한 토큰입니다.
유형: 문자열
필수 항목 여부: 아니요
**`MaxResults`**
페이지가 매겨진 출력의 요청에서 반환되는 결과의 최대 수입니다. 이 파라미터를 사용하면 요청은 `NextToken` 응답 요소와 함께 단일 페이지에서 지정된 수의 결과만 반환합니다. 반환된 `NextToken` 값과 함께 다른 요청을 보내면 초기 요청의 나머지 결과를 확인할 수 있습니다.
유효 범위: 1\$11,000
기본값: 1000
유형: 정수
필수 항목 여부: 아니요
## 응답 파라미터
**`RequestId`**
요청의 고유 ID입니다.
**`Servers`**
Amazon DCV 서버에 대한 정보입니다. 이 데이터 구조에는 다음과 같은 중첩된 응답 파라미터가 포함됩니다.
**`Id`**
Amazon DCV 서버의 고유 ID입니다.
**`Ip`**
Amazon DCV 서버의 IP 주소입니다.
**`Hostname`**
Amazon DCV 서버의 호스트 이름입니다.
**`Endpoints`**
Amazon DCV 서버 엔드포인트에 대한 정보입니다. 이 데이터 구조에는 다음과 같은 중첩된 응답 파라미터가 포함됩니다.
**`IpAddress`**
서버 엔드포인트의 IP 주소입니다.
**`Port`**
서버 엔드포인트의 포트입니다.
**`Protocol`**
서버 엔드포인트가 사용하는 프로토콜입니다. 가능한 값은 다음과 같습니다.
+ `HTTP` - 엔드포인트가 WebSocket(TCP) 프로토콜을 사용합니다.
+ `QUIC` - 엔드포인트가 QUIC(UDP) 프로토콜을 사용합니다.
**`WebUrlPath`**
서버 엔드포인트의 웹 URL 경로입니다. HTTP 프로토콜에만 사용할 수 있습니다.
**`Version`**
Amazon DCV 서버의 버전입니다.
**`SessionManagerAgentVersion`**
Amazon DCV 서버에서 실행되는 세션 관리자 에이전트 버전입니다.
**`Availability`**
Amazon DCV 서버의 가용성입니다. 가능한 값은 다음과 같습니다.
+ `AVAILABLE` - 서버를 사용할 수 있으며 세션을 배치할 준비가 되었습니다.
+ `UNAVAILABLE` - 서버를 사용할 수 없으며 세션 배치를 수락할 수 없습니다.
**`UnavailabilityReason`**
Amazon DCV 서버를 사용할 수 없는 이유입니다. 가능한 값은 다음과 같습니다.
+ `SERVER_FULL` - Amazon DCV 서버가 실행할 수 있는 최대 동시 세션 수에 도달했습니다.
+ `SERVER_CLOSED` - **CloseServer** API를 사용하여 Amazon DCV 서버를 사용할 수 없게 되었습니다.
+ `UNREACHABLE_AGENT` - 세션 관리자 브로커가 Amazon DCV 서버의 세션 관리자 에이전트와 통신할 수 없습니다.
+ `UNHEALTHY_DCV_SERVER` - 세션 관리자 에이전트가 Amazon DCV 서버와 통신할 수 없습니다.
+ `EXISTING_LOGGED_IN_USER` - (Windows Amazon DCV 서버만 해당) 사용자가 현재 RDP를 사용하여 Amazon DCV 서버에 로그인되어 있습니다.
+ `UNKNOWN` - 세션 관리자 브로커가 이유를 확인할 수 없습니다.
**`ConsoleSessionCount`**
Amazon DCV 서버의 콘솔 세션 수입니다.
**`VirtualSessionCount`**
Amazon DCV 서버의 가상 세션 수입니다.
**`Host`**
Amazon DCV 서버가 실행되고 있는 호스트 서버에 대한 정보입니다. 이 데이터 구조에는 다음과 같은 중첩된 응답 파라미터가 포함됩니다.
**`Os`**
호스트 서버 운영 체제에 대한 정보입니다. 이 데이터 구조에는 다음과 같은 중첩된 응답 파라미터가 포함됩니다.
**`Family`**
운영 체제 제품군입니다. 가능한 값은 다음과 같습니다.
+ `windows` - 호스트 서버가 Windows 운영 체제를 실행 중입니다.
+ `linux` - 호스트 서버가 Linux 운영 체제를 실행 중입니다.
**`Name`**
운영 체제 이름.
**`Version`**
운영 체제 버전.
**`KernelVersion`**
(Linux만 해당) 운영 체제의 커널 버전입니다.
**`BuildNumber`**
(Windows만 해당) 운영 체제의 빌드 번호입니다.
**`Memory`**
호스트 서버 메모리에 대한 정보입니다. 이 데이터 구조에는 다음과 같은 중첩된 응답 파라미터가 포함됩니다.
**`TotalBytes`**
호스트 서버의 총 메모리(바이트)입니다.
**`UsedBytes`**
호스트 서버에서 사용된 메모리(바이트)입니다.
**`Swap`**
호스트 서버의 스왑 파일에 대한 정보입니다. 이 데이터 구조에는 다음과 같은 중첩된 응답 파라미터가 포함됩니다.
**`TotalBytes`**
호스트 서버의 총 스왑 파일 크기(바이트)입니다.
**`UsedBytes`**
호스트 서버에서 사용된 스왑 파일 크기(바이트)입니다.
**`Aws`**
Amazon EC2 인스턴스에서 실행되는 Amazon DCV 서버 전용 AWS정보입니다. 이 데이터 구조에는 다음과 같은 중첩된 응답 파라미터가 포함됩니다.
**`Region`**
Amazon EC2 인스턴스의 AWS 리전입니다.
**`Ec2InstanceType`**
Amazon EC2 인스턴스 유형입니다.
**`Ec2InstanceId`**
Amazon EC2 인스턴스의 ID입니다.
**`Ec2ImageId`**
Amazon EC2 이미지의 ID입니다.
**`CpuInfo`**
호스트 서버 CPU에 대한 정보입니다. 이 데이터 구조에는 다음과 같은 중첩된 응답 파라미터가 포함됩니다.
**`Vendor`**
호스트 서버 CPU의 공급업체입니다.
**`ModelName`**
호스트 서버 CPU의 모델 이름입니다.
**`Architecture`**
호스트 서버 CPU의 아키텍처입니다.
**`NumberOfCpus`**
호스트 서버의 CPU 개수입니다.
**`PhysicalCorePerCpu`**
CPU당 CPU 코어 수입니다.
**`CpuLoadAverage`**
호스트 서버 CPU 부하에 대한 정보입니다. 이 데이터 구조에는 다음과 같은 중첩된 응답 파라미터가 포함됩니다.
**`OneMinute`**
마지막 1분 동안의 평균 CPU 부하입니다.
**`FiveMinutes`**
마지막 5분 동안의 평균 CPU 부하입니다.
**`FifteenMinutes`**
마지막 15분 동안의 평균 CPU 부하입니다.
**`Gpus`**
호스트 서버 GPU에 대한 정보입니다. 이 데이터 구조에는 다음과 같은 중첩된 응답 파라미터가 포함됩니다.
**`Vendor`**
호스트 서버 GPU의 공급업체입니다.
**`ModelName`**
호스트 서버 GPU의 모델 이름입니다.
**`LoggedInUsers`**
현재 호스트 서버에 로그인한 사용자입니다. 이 데이터 구조에는 다음과 같은 중첩된 응답 파라미터가 포함됩니다.
**`Username`**
로그인한 사용자의 사용자 이름입니다.
**`Tags`**
서버에 할당된 태그입니다. 이 데이터 구조에는 다음과 같은 중첩된 응답 파라미터가 포함됩니다.
**`Key`**
태그 키
**`Value`**
태그 값
## 예제
------
#### [ Python ]
**요청**
다음 예제에서는 사용 가능한 모든 Amazon DCV 서버에 대해 설명합니다. 결과는 페이지당 두 개의 결과를 표시하도록 페이지가 매겨집니다.
```
from swagger_client.models.describe_servers_request_data import DescribeServersRequestData
def get_servers_api():
api_instance = swagger_client.ServersApi(swagger_client.ApiClient(get_client_configuration()))
set_request_headers(api_instance.api_client)
return api_instance
def describe_servers(server_ids=None, next_token=None, max_results=None):
request = DescribeServersRequestData(server_ids=server_ids, next_token=next_token, max_results=max_results)
print('Describe Servers Request:', request)
api_instance = get_servers_api()
api_response = api_instance.describe_servers(body=request)
print('Describe Servers Response', api_response)
def main():
describe_servers(max_results=2)
```
**응답**
다음은 출력 샘플입니다.
```
{
"RequestId": "request-id-123",
"Servers": [
{
"Id": "ServerId123",
"Ip": "1.1.1.123",
"Hostname": "node001",
"DefaultDnsName": "node001",
"Endpoints": [
{
"IpAddress": "x.x.x.x",
"Port": 8443,
"WebUrlPath": "/",
"Protocol": "HTTP"
}
],
"Version": "2021.0.10000",
"SessionManagerAgentVersion": "2021.0.300",
"Availability": "UNAVAILABLE",
"UnavailabilityReason": "SERVER_FULL",
"ConsoleSessionCount": 1,
"VirtualSessionCount": 0,
"Host": {
"Os": {
"Family": "windows",
"Name": "Windows Server 2016 Datacenter",
"Version": "10.0.14393",
"BuildNumber": "14393"
},
"Memory": {
"TotalBytes": 8795672576,
"UsedBytes": 1743886336
},
"Swap": {
"TotalBytes": 0,
"UsedBytes": 0
},
"Aws": {
"Region": "us-west-2b",
"EC2InstanceType": "t2.large",
"EC2InstanceId": "i-123456789",
"EC2ImageId": "ami-12345678987654321"
},
"CpuInfo": {
"Vendor": "GenuineIntel",
"ModelName": "Intel(R) Xeon(R) CPU E5-2676 v3 @ 2.40GHz",
"Architecture": "x86_64",
"NumberOfCpus": 2,
"PhysicalCoresPerCpu": 3
},
"CpuLoadAverage": {
"OneMinute": 0.04853546,
"FiveMinutes": 0.21060601,
"FifteenMinutes": 0.18792416
},
"Gpus": [],
"LoggedInUsers": [
{
"Username": "Administrator"
}
]
},
"Tags": [
{
"Key": "color",
"Value": "pink"
},
{
"Key": "dcv:os-family",
"Value": "windows"
},
{
"Key": "size",
"Value": "small"
},
{
"Key": "dcv:max-virtual-sessions",
"Value": "0"
}
]
},
{
"Id": "server-id-12456897",
"Ip": "1.1.1.145",
"Hostname": "node002",
"DefaultDnsName": "node002",
"Endpoints": [
{
"IpAddress": "x.x.x.x",
"Port": 8443,
"WebUrlPath": "/",
"Protocol": "HTTP"
},
{
"IpAddress": "x.x.x.x",
"Port": 8443,
"Protocol": "QUIC"
}
],
"Version": "2021.0.10000",
"SessionManagerAgentVersion": "2021.0.0",
"Availability": "AVAILABLE",
"ConsoleSessionCount": 0,
"VirtualSessionCount": 5,
"Host": {
"Os": {
"Family": "linux",
"Name": "Amazon Linux",
"Version": "2",
"KernelVersion": "4.14.203-156.332.amzn2.x86_64"
},
"Memory": {
"TotalBytes": 32144048128,
"UsedBytes": 2184925184
},
"Swap": {
"TotalBytes": 0,
"UsedBytes": 0
},
"Aws": {
"Region": "us-west-2a",
"EC2InstanceType": "g3s.xlarge",
"EC2InstanceId": "i-123456789",
"EC2ImageId": "ami-12345678987654321"
},
"CpuInfo": {
"Vendor": "GenuineIntel",
"ModelName": "Intel(R) Xeon(R) CPU E5-2686 v4 @ 2.30GHz",
"Architecture": "x86_64",
"NumberOfCpus": 4,
"PhysicalCoresPerCpu": 2
},
"CpuLoadAverage": {
"OneMinute": 2.24,
"FiveMinutes": 0.97,
"FifteenMinutes": 0.74
},
"Gpus": [
{
"Vendor": "NVIDIA Corporation",
"ModelName": "GM204GL [Tesla M60]"
}
],
"LoggedInUsers": [
{
"Username" : "user45687"
},
{
"Username" : "user789"
}
]
},
"Tags": [
{
"Key": "size",
"Value": "big"
},
{
"Key": "dcv:os-family",
"Value": "linux"
},
{
"Key": "dcv:max-virtual-sessions",
"Value": "10"
},
{
"Key": "color",
"Value": "blue"
}
]
}
]
}
```
------