DescribeServers - Amazon DCV Session Manager
請求參數回應參數範例

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

DescribeServers

描述一或多個 Amazon DCV 伺服器。

請求參數

ServerIds

要描述的 Amazon DCV 伺服器的 IDs。如果未指定 IDs，則會在分頁輸出中傳回所有伺服器。

類型：字串陣列

必要：否

NextToken

用於擷取結果下一頁的字符。

類型：字串

必要：否

MaxResults

分頁輸出中請求傳回的結果數目上限。使用此參數時，請求只會傳回單一頁面中指定數量的結果，以及NextToken回應元素。傳送另一個具有傳回NextToken值的請求，即可查看初始請求的其餘結果。

有效範圍：1 到 1000

預設：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

伺服器端點的 Web URL 路徑。僅適用於 HTTP 通訊協定。

Version

Amazon DCV 伺服器的版本。

SessionManagerAgentVersion

在 Amazon DCV 伺服器上執行的 Session Manager Agent 版本。

Availability

Amazon DCV 伺服器的可用性。可能的值包括：

  • AVAILABLE — 伺服器可供使用並準備好放置工作階段。

  • UNAVAILABLE — 伺服器無法使用，無法接受工作階段置放。

UnavailabilityReason

Amazon DCV 伺服器無法使用的原因。可能的值包括：

  • SERVER_FULL — Amazon DCV 伺服器已達到可執行的並行工作階段數量上限。

  • SERVER_CLOSED — Amazon DCV 伺服器已無法使用 CloseServer API。

  • UNREACHABLE_AGENT — Session Manager Broker 無法與 Amazon DCV 伺服器上的 Session Manager Agent 通訊。

  • UNHEALTHY_DCV_SERVER — Session Manager Agent 無法與 Amazon DCV 伺服器通訊。

  • EXISTING_LOGGED_IN_USER — （僅限 Windows Amazon DCV 伺服器） 使用者目前使用 RDP 登入 Amazon DCV 伺服器。

  • UNKNOWN — Session Manager Broker 無法判斷原因。

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

主機伺服器 CPUs的相關資訊。此資料結構包含下列巢狀回應參數：

Vendor

主機伺服器的 CPU 廠商。

ModelName

主機伺服器的 CPU 模型名稱。

Architecture

主機伺服器的 CPU 架構。

NumberOfCpus

主機伺服器上CPUs 數量。

PhysicalCorePerCpu

每個 CPU 的 CPU 核心數量。

CpuLoadAverage

主機伺服器的 CPU 負載相關資訊。此資料結構包含下列巢狀回應參數：

OneMinute

過去 1 分鐘期間的平均 CPU 負載。

FiveMinutes

過去 5 分鐘期間的平均 CPU 負載。

FifteenMinutes

過去 15 分鐘期間的平均 CPU 負載。

Gpus

主機伺服器 GPUs 的相關資訊。此資料結構包含下列巢狀回應參數：

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"
                }
            ]
        }
    ]
}