文档

ApplyCoordinationForMonitoring - 申请监控协同

更新时间:

申请监控协同。主要用于管理员协助场景和教育场景。

调试

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

授权信息

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

请求参数

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

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

cn-hangzhou
Uuidstring

设备的 UUID(通用唯一识别码)。

62f2f1f252f04e0e9d8bc****
InitiatorTypestring

发起者类型。

枚举值:
  • ADMIN_INITIATE管理员发起
ADMIN_INITIATE
CoordinatePolicyTypestring

协同策略,暂时只支持桌面及桌面完全控制

枚举值:
  • FULL_CONTROL共享桌面和桌面控制
FULL_CONTROL
ResourceCandidatesobject []

待协同桌面列表。

ResourceTypestring

资源类型。

枚举值:
  • CLOUD_DESKTOP云桌面
CLOUD_DESKTOP
ResourceRegionIdstring

资源所在地域。

cn-hangzhou
ResourcePropertiesstring

桌面属性。

TestProperty
OwnerEndUserIdstring

当前使用者的终端用户 ID。

alice
ResourceIdstring

桌面 ID。

ecd-08zhejm3h7ilr****
ResourceNamestring

桌面名称。

TestDesktop
OwnerAliUidlong

当前桌面拥有者的阿里云账号 ID。

130247021517****
EndUserIdstring

发起流协同的终端用户 ID。若管理员发起,则不需要填写。

alice

返回参数

名称类型描述示例值
object

返回信息集合。

RequestIdstring

请求 ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
CoordinateFlowModelsobject []

协同流数据信息列表。

CoordinateStatusstring

当前协同状态。

枚举值:
  • COORDINATING 协同中
  • TERMINATING 终止中
  • TERMINATED 已终止
  • PENDING 待接受
PENDING
InitiatorTypestring

发起者类型。

枚举值:
  • ADMIN_INITIATE_FORCE管理者强制
  • ADMIN_INITIATE管理员发起
  • COORDINATOR_INITIATE_FORCE协同者强制
COORDINATOR_INITIATE_FORCE
OwnerUserIdstring

用户侧用户的阿里云账号 ID。

alice
CoordinateTicketstring

ASP 建立连接使用的 Ticket。

1VDQ0VTUw0KW0Rlc2t0b3BdDQpHV1Rva2VuPTAwTzgwL3liS25zUEVGdkF6eU1Pc1ExeHZWdmk4VEE3NFJvU1V1d0dPYm1BNkNJWklDMHVNQklWcjU2NS80S0ZQekQ4aGFTR0ZHelZqMTFGbkRpWWgvUFF1Zm1xSXNGdFRFNFRWMExJNit3TkU0L2RMb04wNXBBSE5Tc3M4dWFXY3lwWE****
CoIdstring

协同流 ID。

co-0sot77uale3****
ResourceIdstring

云桌面 ID。

ecd-96vi03f9emqnl****
ResourceNamestring

云桌面名称。

TestDesktop

示例

正常返回示例

JSON格式

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "CoordinateFlowModels": [
    {
      "CoordinateStatus": "PENDING",
      "InitiatorType": "COORDINATOR_INITIATE_FORCE",
      "OwnerUserId": "alice",
      "CoordinateTicket": "1VDQ0VTUw0KW0Rlc2t0b3BdDQpHV1Rva2VuPTAwTzgwL3liS25zUEVGdkF6eU1Pc1ExeHZWdmk4VEE3NFJvU1V1d0dPYm1BNkNJWklDMHVNQklWcjU2NS80S0ZQekQ4aGFTR0ZHelZqMTFGbkRpWWgvUFF1Zm1xSXNGdFRFNFRWMExJNit3TkU0L2RMb04wNXBBSE5Tc3M4dWFXY3lwWE****",
      "CoId": "co-0sot77uale3****",
      "ResourceId": "ecd-96vi03f9emqnl****",
      "ResourceName": "TestDesktop"
    }
  ]
}

错误码

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

变更历史

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