DescribeSessions

하나 이상의 NICE DCV 세션을 설명합니다.

요청 파라미터

SessionIds

설명할 세션의 ID입니다.

유형: 문자열

필수 항목 여부: 아니요

NextToken

결과의 다음번 페이지를 가져오기 위한 토큰입니다.

유형: 문자열

필수 항목 여부: 아니요

Filters

요청에 적용할 추가 필터입니다. 지원되는 필터는 다음과 같습니다.

• tag:key - 세션에 할당된 태그입니다.

• owner - 세션 소유자입니다.

유형: 문자열

필수 항목 여부: 아니요

응답 파라미터

Id

세션의 고유 ID입니다.

Name

세션의 이름입니다.

Owner

세션 소유자입니다.

Server

세션이 실행되고 있는 서버의 정보입니다. 이 데이터 구조에는 다음과 같은 중첩된 응답 파라미터가 포함됩니다.

Ip

NICE DCV 서버 호스트의 IP 주소입니다.

Hostname

NICE DCV 서버 호스트의 호스트 이름입니다.

Port

NICE DCV 서버가 NICE DCV 클라이언트와 통신하는 데 사용되는 포트입니다.

Endpoints

NICE DCV 서버 엔드포인트에 대한 정보입니다. 이 데이터 구조에는 다음과 같은 중첩된 응답 파라미터가 포함됩니다.

IpAddress

서버 엔드포인트의 IP 주소입니다.

Port

서버 엔드포인트의 포트입니다.

Protocol

서버 엔드포인트가 사용하는 프로토콜입니다. 가능한 값은 다음과 같습니다.

• HTTP - 엔드포인트가 WebSocket(TCP) 프로토콜을 사용합니다.

• QUIC - 엔드포인트가 QUIC(UDP) 프로토콜을 사용합니다.

WebUrlPath

서버 엔드포인트의 웹 URL 경로입니다. HTTP 프로토콜에만 사용할 수 있습니다.

Tags

서버에 할당된 태그입니다. 이 데이터 구조에는 다음과 같은 중첩된 응답 파라미터가 포함됩니다.

Key

태그 키.

Value

태그 값.

Type

세션 유형입니다.

State

세션의 현재 상태입니다. 가능한 값은 다음과 같습니다.

• CREATING - 브로커가 세션을 생성하는 중입니다.

• READY - 세션이 클라이언트 연결을 수락할 준비가 되었습니다.

• DELETING - 세션을 삭제 중입니다.

• DELETED - 세션이 삭제되었습니다.

• UNKNOWN - 세션 상태를 확인할 수 없습니다. 브로커와 에이전트가 통신하지 못할 수 있습니다.

Substate

세션의 현재 하위 상태입니다. 가능한 값은 다음과 같습니다.

• SESSION_PLACING - 세션이 사용 가능한 DCV 서버에 배치되기를 기다리고 있습니다.

• PENDING_PREPARATION - 세션이 생성되었지만 사용할 수 없으며 DCV 서버에 연결되어 있습니다.

CreationTime

세션이 생성된 날짜와 시간입니다.

LastDisconnectionTime

클라이언트의 마지막 연결 해제 날짜 및 시간입니다.

NumOfConnections

활성 클라이언트 연결 수입니다.

StorageRoot

세션 스토리지에 사용되는 폴더 경로를 지정합니다. NICE DCV 세션 스토리지에 대한 자세한 내용은 NICE DCV 관리자 안내서의 세션 스토리지 활성화를 참조하세요.

유형: 문자열

필수 항목 여부: 아니요

예

Python

요청

다음 예제에서는 user1에서 소유하고 os=windows 태그가 있는 세션에 대해 설명합니다.

from swagger_client.models.describe_sessions_request_data import DescribeSessionsRequestData
from swagger_client.models.key_value_pair import KeyValuePair

def get_sessions_api():
    api_instance = swagger_client.SessionsApi(swagger_client.ApiClient(get_client_configuration()))
    set_request_headers(api_instance.api_client)
    return api_instance

def describe_sessions(session_ids=None, next_token=None, tags=None, owner=None):
    filters = list()
    if tags:
        for tag in tags:
            filter_key_value_pair = KeyValuePair(key='tag:' + tag['Key'], value=tag['Value'])
            filters.append(filter_key_value_pair)
    if owner:
        filter_key_value_pair = KeyValuePair(key='owner', value=owner)
        filters.append(filter_key_value_pair)

    request = DescribeSessionsRequestData(session_ids=session_ids, filters=filters, next_token=next_token)
    print('Describe Sessions Request:', request)
    api_instance = get_sessions_api()
    api_response = api_instance.describe_sessions(body=request)
    print('Describe Sessions Response', api_response)

def main():
    describe_sessions(
        owner='user1',
        tags=[{'Key': 'os', 'Value': 'windows'}])

응답

다음은 출력 샘플입니다.

{
    "Sessions": [
        {
            "Id": "SessionId1897",
            "Name": "a session name",
            "Owner": "an owner 1890",
            "Server": {
                "Ip": "1.1.1.123",
                "Hostname": "server hostname",
                "Port": "1222",
                "Endpoints": [
                    {
                        "IpAddress": "x.x.x.x",
                        "Port": 8443,
                        "WebUrlPath": "/",
                        "Protocol": "HTTP"
                    },
                    {
                        "IpAddress": "x.x.x.x",
                        "Port": 9443,
                        "WebUrlPath": "/",
                        "Protocol": "HTTP"
                    },
                    {
                        "IpAddress": "x.x.x.x",
                        "Port": 8443,
                        "WebUrlPath": "",
                        "Protocol": "QUIC"
                    }
                ],
                "Tags": [
                    {
                        "Key": "os",
                        "Value": "windows"
                    },
                    {
                        "Key": "ram",
                        "Value": "4gb"
                    }
                ]
            },
            "Type": "VIRTUAL",
            "State": "READY",
            "CreationTime": "2020-10-06T10:15:31.633Z",
            "LastDisconnectionTime": "2020-10-06T10:15:31.633Z",
            "NumOfConnections": 2,
            "StorageRoot" : "/storage/root"
        },
        {
            "Id": "SessionId1895",
            "Name": "a session name",
            "Owner": "an owner 1890",
            "Server": {
                "Ip": "1.1.1.123",
                "Hostname": "server hostname",
                "Port": "1222",
                "Endpoints": [
                    {
                        "IpAddress": "x.x.x.x",
                        "Port": 8443,
                        "WebUrlPath": "/",
                        "Protocol": "HTTP"
                    },
                    {
                        "IpAddress": "x.x.x.x",
                        "Port": 9443,
                        "WebUrlPath": "/",
                        "Protocol": "HTTP"
                    },
                    {
                        "IpAddress": "x.x.x.x",
                        "Port": 8443,
                        "WebUrlPath": "",
                        "Protocol": "QUIC"
                    }
                ],
                "Tags": [
                    {
                        "Key": "os",
                        "Value": "windows"
                    },
                    {
                        "Key": "ram",
                        "Value": "4gb"
                    }
                ]
            },
            "Type": "VIRTUAL",
            "State": "DELETING",
            "CreationTime": "2020-10-06T10:15:31.633Z",
            "LastDisconnectionTime": "2020-10-06T10:15:31.633Z",
            "NumOfConnections": 2,
            "StorageRoot" : "/storage/root"
        }
    ]
}