Permintaan parameter Parameter respons Contoh

DescribeServers

Menjelaskan satu atau lebih server Amazon DCV.

Topik

Permintaan parameter
Parameter respons
Contoh

Permintaan parameter

ServerIds

Server Amazon DCV untuk dijelaskan. IDs Jika tidak IDs ditentukan, semua server dikembalikan dalam output paginasi.

Tipe: Array string

Wajib: Tidak

NextToken

Token yang digunakan untuk mengambil halaman hasil berikutnya.

Tipe: String

Wajib: Tidak

MaxResults

Jumlah maksimum hasil yang akan dikembalikan oleh permintaan dalam output paginasi. Ketika parameter ini digunakan, permintaan hanya mengembalikan jumlah hasil yang ditentukan dalam satu halaman bersama dengan elemen NextToken respons. Hasil yang tersisa dari permintaan awal dapat dilihat dengan mengirimkan permintaan lain dengan NextToken nilai yang dikembalikan.

Rentang yang valid: 1 - 1000

Default: 1000

Tipe: Integer

Wajib: Tidak

Parameter respons

RequestId

ID unik dari permintaan.

Servers

Informasi tentang server Amazon DCV. Struktur data ini mencakup parameter respons bersarang berikut:

Id

ID unik dari server Amazon DCV.

Ip

Alamat IP server Amazon DCV.

Hostname

Nama host dari server Amazon DCV.

Endpoints

Informasi tentang titik akhir server Amazon DCV. Struktur data ini mencakup parameter respons bersarang berikut:

IpAddress

Alamat IP dari titik akhir server.

Port

Port dari endpoint server.

Protocol

Protokol yang digunakan oleh endpoint server. Nilai yang mungkin termasuk:

HTTPEndpoint menggunakan protokol WebSocket (TCP).
QUICEndpoint menggunakan protokol QUIC (UDP).

WebUrlPath

Jalur URL web dari titik akhir server. Hanya tersedia untuk protokol HTTP.

Version

Versi server Amazon DCV.

SessionManagerAgentVersion

Versi Session Manager Agent berjalan di server Amazon DCV.

Availability

Ketersediaan server Amazon DCV. Nilai yang mungkin termasuk:

AVAILABLE— Server tersedia dan siap untuk penempatan sesi.
UNAVAILABLE— Server tidak tersedia dan tidak dapat menerima penempatan sesi.

UnavailabilityReason

Alasan tidak tersedianya server Amazon DCV. Nilai yang mungkin termasuk:

SERVER_FULL— Server Amazon DCV telah mencapai jumlah maksimum sesi bersamaan yang dapat dijalankan.
SERVER_CLOSED— Server Amazon DCV telah dibuat tidak tersedia menggunakan API. CloseServer
UNREACHABLE_AGENT— Broker Manajer Sesi tidak dapat berkomunikasi dengan Agen Manajer Sesi di server Amazon DCV.
UNHEALTHY_DCV_SERVER— Agen Manajer Sesi tidak dapat berkomunikasi dengan server Amazon DCV.
EXISTING_LOGGED_IN_USER— (Hanya server Windows Amazon DCV) Seorang pengguna saat ini masuk ke server Amazon DCV menggunakan RDP.
UNKNOWN— Broker Manajer Sesi tidak dapat menentukan alasannya.

ConsoleSessionCount

Jumlah sesi konsol di server Amazon DCV.

VirtualSessionCount

Jumlah sesi virtual di server Amazon DCV.

Host

Informasi tentang server host tempat server Amazon DCV berjalan. Struktur data ini mencakup parameter respons bersarang berikut:

Os

Informasi tentang sistem operasi server host. Struktur data ini mencakup parameter respons bersarang berikut:

Family

Keluarga sistem operasi. Nilai yang mungkin termasuk:

windows— Server host menjalankan sistem operasi Windows.
linux— Server host menjalankan sistem operasi Linux.

Name

Nama sistem operasi.

Version

Versi sistem operasi.

KernelVersion

(Hanya Linux) Versi kernel dari sistem operasi.

BuildNumber

(Hanya Windows) Nomor build sistem operasi.

Memory

Informasi tentang memori server host. Struktur data ini mencakup parameter respons bersarang berikut:

TotalBytes: Total memori, dalam byte, di server host.
UsedBytes: Memori yang digunakan, dalam byte, di server host.

Swap

Informasi tentang file swap server host. Struktur data ini mencakup parameter respons bersarang berikut:

TotalBytes: Ukuran file swap total, dalam byte, di server host.
UsedBytes: Ukuran file swap yang digunakan, dalam byte, di server host.

Aws

Hanya untuk server Amazon DCV yang berjalan pada EC2 instans Amazon. AWS-informasi spesifik. Struktur data ini mencakup parameter respons bersarang berikut:

Region: AWS Wilayah EC2 contoh Amazon.
Ec2InstanceType: Jenis EC2 contoh Amazon.
Ec2InstanceId: ID dari EC2 instans Amazon.
Ec2ImageId: ID EC2 gambar Amazon.

CpuInfo

Informasi tentang server host CPUs. Struktur data ini mencakup parameter respons bersarang berikut:

Vendor: Vendor CPU server host.
ModelName: Nama model CPU server host.
Architecture: Arsitektur CPU server host.
NumberOfCpus: Jumlah CPUs di server host.
PhysicalCorePerCpu: Jumlah core CPU per CPU.

CpuLoadAverage

Informasi tentang beban CPU server host. Struktur data ini mencakup parameter respons bersarang berikut:

OneMinute: Beban CPU rata-rata selama periode 1 menit terakhir.
FiveMinutes: Beban CPU rata-rata selama periode 5 menit terakhir.
FifteenMinutes: Beban CPU rata-rata selama periode 15 menit terakhir.

Gpus

Informasi tentang server host GPUs. Struktur data ini mencakup parameter respons bersarang berikut:

Vendor: Vendor GPU server host.
ModelName: Nama model GPU server host.

LoggedInUsers

Pengguna yang saat ini masuk ke server host. Struktur data ini mencakup parameter respons bersarang berikut:

Username: Nama pengguna pengguna yang masuk.

Tags

Tag yang ditetapkan ke server. Struktur data ini mencakup parameter respons bersarang berikut:

Key: Kunci tanda.
Value: Nilai tanda.

Contoh

Python

Permintaan

Contoh berikut menjelaskan semua server Amazon DCV yang tersedia. Hasilnya diberi paginasi untuk menunjukkan dua hasil per halaman.


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)

Respons

Berikut ini adalah output sampel.


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

Awas Javascript dinonaktifkan atau tidak tersedia di browser Anda.

Untuk menggunakan Dokumentasi AWS, Javascript harus diaktifkan. Lihat halaman Bantuan browser Anda untuk petunjuk.

Konvensi Dokumen

CreateSessions

DescribeSessions