获取云电脑连接凭证。
接口说明
云电脑的状态必须为运行中(Running),使用该接口获取的 Ticket 过期时间为 10 分钟。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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****"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2022-09-28 | OpenAPI 入参发生变更 | 查看变更详情 |