全部產品
Search
文件中心

Elastic Desktop Service:DescribeDesktopSessions - 查詢雲電腦會話詳情

更新時間:Mar 13, 2026

查詢雲電腦的詳細會話資訊。

介面說明

當前僅支援查詢 30 天以內的資料。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱

類型

必填

描述

樣本值

RegionId

string

地區 ID。可以調用 DescribeRegions 擷取無影雲電腦支援的地區列表。

cn-hangzhou

OfficeSiteId

string

辦公網路識別碼。

cn-hangzhou+dir-363353****

EndUserId

string

終端使用者識別碼。

alice

SessionStatus

string

會話串連狀態。

枚舉值:

  • Connected :

    已串連

  • Disconnected :

    已斷開

Connected

StartTime

string

查詢開始時間。

2023-01-28T02:31:43Z

EndTime

string

查詢結束時間。

2023-02-13T02:51:43Z

PageNumber

integer

分頁查詢時,當前頁的頁碼。

1

PageSize

integer

分頁查詢時,每頁最大行數。

10

DesktopId

array

雲電腦 ID。可設定 1~100 個。

string

雲電腦 ID。

ecd-gx2x1dhsmucyy****"

DesktopName

string

雲電腦名稱。

DemoComputer

SubPayType

string

雲電腦購買方式。

枚舉值:

  • duration :

    時間長度包 [白名單]

  • postPaid :

    按需購買

  • monthPackage :

    按月購買(120 小時/250 小時)

  • prePaid :

    按月購買(不限時間長度)

monthPackage

CheckOsSession

boolean

檢查雲電腦內工作階段狀態的開關。

true

EndUserIdFilter

string

終端使用者識別碼。與參數EndUserId相同,兩者只需要傳入一個即可。

alice

ResourceGroupId

string

FillHardwareInfo

boolean

是否增加終端資訊返回。

Language

string

返回資訊的語言類型。

zh-CN

返回參數

名稱

類型

描述

樣本值

object

TotalCount

integer

查詢結果總數。

1

RequestId

string

請求 ID。

3EC4A6DB-EC8D-55B0-9038-543DE671****

Sessions

array<object>

會話詳情。

array<object>

會話詳情。

SessionStatus

string

會話串連狀態。

枚舉值:

  • Connected :

    已串連

  • Disconnected :

    已斷開

Connected

EndUserId

string

終端使用者識別碼。

alice

OfficeSiteId

string

辦公網路識別碼。

cn-hangzhou+dir-8904****

ClientIp

string

用戶端 IP。

172.21.XX.XX

ClientOS

string

用戶端作業系統。

windows_\"Windows10Enterprise\"10.0(Build22000)

DesktopId

string

雲電腦 ID。

ecd-g6t1ukbaea****

DesktopName

string

雲電腦名稱。

DemoComputer

OfficeSiteName

string

辦公網路名稱。

TestOfficeSite

ClientVersion

string

用戶端版本。

2.0.0-R-20221030.08****

ProtocolType

string

協議類型。

枚舉值:

  • HDX :

    HDX 協議

  • ASP :

    阿里雲自研 ASP 協議

ASP

LatestConnectionTime

integer

最近一次串連雲電腦的時間長度。單位:秒。

120

TotalConnectionTime

integer

總串連時間長度。單位:秒。

240

SessionStartTime

string

會話的開始時間。

2023-01-28T02:31:43Z

SessionEndTime

string

會話的結束時間。

2023-01-28T02:31:43Z

SessionIdleTime

integer

會話空閑時間長度。單位:秒。

120

OsType

string

作業系統類型。

枚舉值:

  • Linux :

    Linux

  • Windows :

    Windows

Windows

EndUserApplyCoordinateTime

integer

終端使用者遠程協助時間長度。單位:秒。

120

SubPayType

string

雲電腦購買方式。

枚舉值:

  • duration :

    時間長度包 [白名單]

  • postPaid :

    按需購買

  • monthPackage :

    按月購買(120 小時/250 小時)

  • prePaid :

    按月購買(不限時間長度)

monthPackage

OsSessionStatus

string

檢查雲電腦內工作階段狀態的開關。

true

TerminalInfo

object

終端裝置資訊描述。

ProductName

string

終端裝置類型。

Mac

SerialNumber

string

終端裝置序號。

96c530bc-6095-4014-8bbc-d461b8ac****

Model

string

終端裝置資訊。

Mac

Uuid

string

登入裝置的 UUID。

EBFDC7773BEBAD418A9F89429652****

DirectoryType

string

辦公網路類型

SIMPLE

AccountType

string

帳號類型

SIMPLE

ResourceGroups

array<object>

資源群組資訊

object

資源群組

Id

string

資源群組 ID

rg-8whrmo2gtsb8bxxxx

Name

string

資源群組名稱

RgTest

SessionIdleTime 僅當雲電腦作業系統為 Windows 時返回。

樣本

正常返回樣本

JSON格式

{
  "TotalCount": 1,
  "RequestId": "3EC4A6DB-EC8D-55B0-9038-543DE671****",
  "Sessions": [
    {
      "SessionStatus": "Connected",
      "EndUserId": "alice",
      "OfficeSiteId": "cn-hangzhou+dir-8904****",
      "ClientIp": "172.21.XX.XX",
      "ClientOS": "windows_\\\"Windows10Enterprise\\\"10.0(Build22000)",
      "DesktopId": "ecd-g6t1ukbaea****",
      "DesktopName": "DemoComputer",
      "OfficeSiteName": "TestOfficeSite",
      "ClientVersion": "2.0.0-R-20221030.08****",
      "ProtocolType": "ASP",
      "LatestConnectionTime": 120,
      "TotalConnectionTime": 240,
      "SessionStartTime": "2023-01-28T02:31:43Z\n",
      "SessionEndTime": "2023-01-28T02:31:43Z",
      "SessionIdleTime": 120,
      "OsType": "Windows",
      "EndUserApplyCoordinateTime": 120,
      "SubPayType": "monthPackage",
      "OsSessionStatus": "true",
      "TerminalInfo": {
        "ProductName": "Mac",
        "SerialNumber": "96c530bc-6095-4014-8bbc-d461b8ac****",
        "Model": "Mac",
        "Uuid": "EBFDC7773BEBAD418A9F89429652****"
      },
      "DirectoryType": "SIMPLE",
      "AccountType": "SIMPLE",
      "ResourceGroups": [
        {
          "Id": "rg-8whrmo2gtsb8bxxxx",
          "Name": "RgTest"
        }
      ]
    }
  ]
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情