DescribeServers

1 つ以上の Amazon DCV サーバーを記述します。

リクエストパラメータ

ServerIds

記述する Amazon DCV サーバーの ID。ID を一切指定しない場合、すべてのサーバーがページ割り出力で返されます。

型: 文字列の配列

必須: いいえ

NextToken

次の結果ページの取得に使用するトークン。

タイプ: 文字列

必須: いいえ

MaxResults

ページ割り出力でリクエストにより返される結果の最大数。このパラメータを使用すると、リクエストにより、指定した件数の結果と NextToken レスポンス要素が 1 ページにまとめられて返されます。最初のリクエストの残りの結果は、返された 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

サーバーエンドポイントのウェブ 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 サーバーについて説明します。結果はページ割りされ、ページごとに結果が 2 件ずつ表示されます。

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