文档

GetCoordinateTicket - 获取协同流凭证

更新时间:

获取协同流凭证,用于进行远程协助或共享协同。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。可以调用 DescribeRegions 获取无影云桌面支持的地域列表。

cn-hangzhou
CoIdstring

协同流 ID。来自接口ApplyCoordinationForMonitoring返回的Coid

co-0sot77uale3****
TaskIdstring

桌面连接任务 ID。首次请求不需要,首次请求如果没有返回 ticket, 后续请求根据首次返回的 taskId 填写

39cc15e5-6998-4b9f-9b2c-7a4cc3e2****
EndUserIdstring

便捷账号名称。管理员侧不需要。

Alice
UserTypestring

用户类型。

枚举值:
  • TENANT_ADMIN管理员
TENANT_ADMIN

返回参数

名称类型描述示例值
object
CoIdstring

协同流 ID。

co-0sot77uale3****
RequestIdstring

请求 ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
TaskStatusstring

任务状态。

枚举值:
  • FinishedFinished
  • FailedFailed
  • RunningRunning
Finished
TaskIdstring

桌面连接任务 ID。

39cc15e5-6998-4b9f-9b2c-7a4cc3e2****
Ticketstring

协同流凭证。

W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********

示例

正常返回示例

JSON格式

{
  "CoId": "co-0sot77uale3****",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "TaskStatus": "Finished",
  "TaskId": "39cc15e5-6998-4b9f-9b2c-7a4cc3e2****",
  "Ticket": "W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (0)
文档反馈