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

# DescribeSessions
<a name="DescribeSessions"></a>

描述一或多個 Amazon DCV 工作階段。

**Topics**
+ [

## 請求參數
](#request)
+ [

## 回應參數
](#response)
+ [

## 範例
](#example)

## 請求參數
<a name="request"></a>

**`SessionIds`**  
要描述的工作階段 IDs。  
類型：字串  
必要：否

**`NextToken`**  
用於擷取結果下一頁的字符。  
類型：字串  
必要：否

**`Filters`**  
要套用至請求的其他篩選條件。支援的篩選條件包括：  
+ tag：key - 指派給工作階段的標籤。
+ owner - 工作階段擁有者。
類型：字串  
必要：否

## 回應參數
<a name="response"></a>

**`Id`**  
工作階段的唯一 ID。

**`Name`**  
工作階段的名稱。

**`Owner`**  
工作階段的擁有者。

**`Server`**  
工作階段執行所在伺服器的相關資訊。此資料結構包含下列巢狀回應參數：    
**`Ip`**  
Amazon DCV 伺服器主機的 IP 地址。  
**`Hostname`**  
Amazon DCV 伺服器主機的主機名稱。  
**`Port`**  
Amazon DCV 伺服器與 Amazon DCV 用戶端通訊的連接埠。  
**`Endpoints`**  
Amazon DCV 伺服器端點的相關資訊。此資料結構包含下列巢狀回應參數：    
**`IpAddress`**  
伺服器端點的 IP 地址。  
**`Port`**  
伺服器端點的連接埠。  
**`Protocol`**  
伺服器端點所使用的通訊協定。可能的值包括：  
+ `HTTP` — 端點使用 WebSocket (TCP) 通訊協定。
+ `QUIC` — 端點使用 QUIC (UDP) 通訊協定。  
**`WebUrlPath`**  
伺服器端點的 Web URL 路徑。僅適用於 HTTP 通訊協定。  
**`Tags`**  
指派給伺服器的標籤。此資料結構包含下列巢狀回應參數：    
**`Key`**  
標籤金鑰。  
**`Value`**  
標籤值。

**`Type`**  
工作階段的類型。

**`State`**  
工作階段的目前狀態。可能值為：  
+ `CREATING` - 中介裝置正在建立工作階段。
+ `READY` - 工作階段已準備好接受用戶端連線。
+ `DELETING` - 正在刪除工作階段。
+ `DELETED` - 已刪除工作階段。
+ `UNKNOWN` - 無法判斷工作階段的狀態。中介裝置和代理程式可能無法通訊。

**`Substate`**  
工作階段的目前子狀態。可能值為：  
+ `SESSION_PLACING` - 工作階段正在等待放置在可用的 DCV 伺服器上。
+ `PENDING_PREPARATION` - 工作階段已建立但無法使用；連結至 DCV 伺服器。

**`CreationTime`**  
工作階段建立的日期和時間。

**`LastDisconnectionTime`**  
上次用戶端中斷連線的日期和時間。

**`NumOfConnections`**  
作用中用戶端連線的數量。

**`StorageRoot`**  
指定要用於儲存工作階段之資料夾的路徑。如需 Amazon DCV 工作階段儲存體的詳細資訊，請參閱《*Amazon DCV 管理員指南*》中的[啟用工作階段儲存](https://docs.aws.amazon.com/dcv/latest/adminguide/manage-storage.html)體。  
類型：字串  
必要：否

## 範例
<a name="example"></a>

------
#### [ 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"
        }
    ]
}
```

------