DescribeServers - NICE DCV 会话管理器
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

DescribeServers

描述一个或多个 NICE DCV 服务器。

请求参数

ServerIds

要描述的 NICE DCV 服务器的 ID。如果未指定 ID,则在分页输出中返回所有服务器。

类型: 字符串数组

:必需 否

NextToken

用于检索下一页结果的令牌。

类型: 字符串

:必需 否

MaxResults

请求返回分页输出中的最大结果数。使用此参数时,请求仅返回单个页面中指定数量的结果以及NextToken响应元素。初始请求的剩余结果可以通过发送另一个请求并返回NextToken值。

有效范围:1-1000

默认值:1000

类型: 整数

:必需 否

响应参数

RequestId

请求的唯一 ID。

Servers

有关 NICE DCV 服务器的信息。此数据结构包括以下嵌套响应参数:

Id

NICE DCV 服务器的唯一 ID。

Ip

NICE DCV 服务器的 IP 地址。

Hostname

NICE DCV 服务器的主机名。

Endpoints

有关 NICE DCV 服务器终端节点的信息。此数据结构包括以下嵌套响应参数:

Port

服务器终端节点的端口。

WebUrlPath

服务器终端节点的 Web URL 路径。仅适用于 HTTP 协议。

Protocol

服务器终端节点使用的协议。可能的值包括:

  • HTTP— 终端节点使用 WebSocket (TCP) 协议。

  • QUIC— 终端使用 QUIC (UDP) 协议。

Version

NICE DCV 服务器的版本。

SessionManagerAgentVersion

在 NICE DCV 服务器上运行的版本会话管理器代理。

Availability

NICE DCV 服务器的可用性。可能的值包括:

  • AVAILABLE— 服务器可用并准备好进行会话放置。

  • UNAVAILABLE— 服务器不可用且无法接受会话放置。

UnavailabilityReason

NICE DCV 服务器不可用的原因。可能的值包括:

  • SERVER_FULL— NICE DCV 服务器已达到它可以运行的最大并发会话数。

  • SERVER_CLOSED— NICE DCV 服务器已使用闭合服务器API。

  • UNREACHABLE_AGENT— 会话管理器代理无法与 NICE DCV 服务器上的会话管理器代理进行通信。

  • UNHEALTHY_DCV_SERVER— 会话管理器代理无法与 NICE DCV 服务器进行通信。

  • EXISTING_LOGGED_IN_USER—(仅限 Windows NICE DCV 服务器)用户当前使用 RDP 登录到 NICE DCV 服务器。

  • UNKNOWN— 会话管理器代理无法确定原因。

ConsoleSessionCount

NICE DCV 服务器上的控制台会话数。

VirtualSessionCount

NICE DCV 服务器上的虚拟会话数。

Host

有关运行 NICE DCV 服务器的主机服务器的信息。此数据结构包括以下嵌套响应参数:

Os

有关主机服务器操作系统的信息。此数据结构包括以下嵌套响应参数:

Family

操作系统系列。可能的值包括:

  • windows— 主机服务器正在运行 Windows 操作系统。

  • linux— 主机服务器正在运行 Linux 操作系统。

Name

操作系统的名称。

Version

操作系统的版本。

KernelVersion

(仅限于 Linux)操作系统的内核版本。

BuildNumber

(仅限 Windows)操作系统的内部版本号。

Memory

有关主机服务器内存的信息。此数据结构包括以下嵌套响应参数:

TotalBytes

主机服务器上的总内存(以字节为单位)。

UsedBytes

主机服务器上已用内存(以字节为单位)。

Swap

有关主机服务器交换文件的信息。此数据结构包括以下嵌套响应参数:

TotalBytes

主机服务器上的交换文件总大小(以字节为单位)。

UsedBytes

主机服务器上已使用的交换文件大小(以字节为单位)。

Aws

仅适用于在 Amazon EC2 实例上运行的 NICE DCV 服务器。Amazon特定信息。此数据结构包括以下嵌套响应参数:

Region

这些区域有:AmazonAmazon EC2 实例的区域。

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

前一分钟时间段的平均 CPU 负载。

FiveMinutes

前 5 分钟时间段的平均 CPU 负载。

FifteenMinutes

前 15 分钟时间段的平均 CPU 负载。

Gpus

有关主机服务器 GPU 的信息。此数据结构包括以下嵌套响应参数:

Vendor

主机服务器的 GPU 的供应商。

ModelName

主机服务器 GPU 的型号名称。

LoggedInUsers

当前登录到主机服务器的用户。此数据结构包括以下嵌套响应参数:

Username

已登录用户的用户名。

Tags

分配给服务器的标签。此数据结构包括以下嵌套响应参数:

Key

标签键。

Value

标签值。

Example

Python

Request

以下示例介绍了所有可用的 NICE DCV 服务器。对结果进行分页以显示每页两个结果。

from swagger_client.models.describe_servers_request_data import DescribeServersRequestData def get_sessions_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_sessions(max_results=2)

Response

下面是示例输出。

{ "RequestId": "request-id-123", "Servers": [ { "Id": "ServerId123", "Ip": "1.1.1.123", "Hostname": "node001", "Endpoints": [ { "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", "Endpoints": [ { "Port": 8443, "WebUrlPath": "/", "Protocol": "HTTP" }, { "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" } ] } ] }