獲取云電腦連接憑證。
接口說明
云電腦的狀態必須為運行中(Running),使用該接口獲取的 Ticket 過期時間為 10 分鐘。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
ecd:GetConnectionTicket | get |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID。可以調用 DescribeRegions 獲取無影云電腦支持的地域列表。 | cn-hangzhou |
EndUserId | string | 否 | 云電腦授權用戶的用戶名。必須傳入云電腦現有的授權用戶才能成功生成憑證。 | alice |
Password | string | 否 | 云電腦授權用戶的密碼。 | Ab123456 |
TaskId | string | 否 | 云電腦連接任務 ID。 | 2afbad19-778a-4fc5-9674-1f19c638**** |
DesktopId | string | 否 | 需生成連接憑證的云電腦 ID。必須傳入該字段才能成功生成憑證。 | ecd-gx2x1dhsmucyy**** |
Uuid | string | 否 | 客戶端唯一標識。若使用無影客戶端,可在客戶端登錄界面的關于對話框中查看該參數。 | 28c80e90-f71e-4c23-93d6-1225329cf949 |
CommandContent | string | 否 | 當前參數可以配置自定義用戶態應用,當成功獲取憑證后,自動執行應用。
| { "startApplication": { "startApplicationList": [ { "sessionName": "", "appList": [ { "appPath": "C:\\Program Files\\Google\\Chrome\\Application\\chrome.exe", "appParameter": "www.example.com www.example1.com" } ] } ] } } |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
"TaskStatus": "FINISHED",
"Ticket": "W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********",
"TaskId": "2afbad19-778a-4fc5-9674-1f19c638****",
"TaskCode": "",
"TaskMessage": "",
"DesktopId": ""
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2022-09-28 | OpenAPI 入參發生變更 | 查看變更詳情 |