獲取桌面連接憑證。
接口說明
首次調用該接口時,將返回TaskID
,使用該TaskID
繼續調用該接口,直到TaskStatus
的值變為 FINISHED 或者 FAILED。TaskStatus
為 FINISHED 時,Ticket
的值即為客戶端連接桌面的 Ticket。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID。可以調用 DescribeRegions 獲取無影云桌面支持的地域列表。 | cn-hangzhou |
ClientId | string | 是 | 客戶端生成的唯一 ID。 | f4a0dc8e-1702-4728-9a60-95b27a35**** |
SessionId | string | 是 | 會話 ID。調用 GetLoginToken 獲取 | cd45e873-650d-4d70-acb9-f996187a**** |
LoginToken | string | 是 | 登錄憑證。調用 GetLoginToken 獲取 | v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b**** |
TaskId | string | 否 | 桌面連接任務 ID。 | 2afbad19-778a-4fc5-9674-1f19c638**** |
DesktopId | string | 否 | 云桌面 ID。 | ecd-gx2x1dhsmucyy**** |
ClientOS | string | 否 | 客戶端操作系統。 | Windows_NT 10.0.18363 x64 |
ClientVersion | string | 否 | 客戶端版本。 | 2.1.0-R-20210731.151756 |
ClientType | string | 否 | 客戶端類型。取值范圍:
| windows |
CommandContent | string | 否 | 當前參數可以配置自定義用戶態應用,當成功獲取憑證后,自動執行應用。
| { "startApplication": { "startApplicationList": [ { "sessionName": "", "appList": [ { "appPath": "C:\\Program Files\\Google\\Chrome\\Application\\chrome.exe", "appParameter": "www.example.com www.example1.com" } ] } ] } } |
Uuid | string | 否 | 客戶端唯一標識。若使用無影客戶端,可在客戶端登錄界面的關于對話框中查看該參數。 | 28c80e90-f71e-4c23-93d6-1225329cf949 |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
"TaskStatus": "FINISHED",
"Ticket": "W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********",
"TaskId": "2afbad19-778a-4fc5-9674-1f19c63862da",
"TaskCode": "W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********",
"TaskMessage": "2afbad19-778a-4fc5-9674-1f19c638****"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | DesktopMemoryHighLoad%s | The specified desktop memory high load. | 此臺云電腦的內存使用率過高導致連接超時,占用內存最高的應用為%s。請重新連接或重啟云電腦。如仍舊出現連接失敗,請聯系IT管理員. |
400 | DesktopCpuHighLoad%s | The specified desktop cpu high load. | 此臺云電腦的CPU使用率過高導致連接超時,占用CPU最高的應用為%s。請重新連接或重啟云電腦。如仍舊出現連接失敗,請聯系IT管理員。 |
400 | InvalidClientIp.Policy | Client ip %s is not in white list. | IT管理員設置了IP白名單策略導致無法在您目前的IP環境(%s)下連接此臺云電腦,請聯系IT管理員。 |
訪問錯誤中心查看更多錯誤碼。