批量分配用户到多台云电脑。
接口说明
云电脑的状态必须为运行中(Running)。
本接口立刻返回结果,如需查询分配是否成功,请调用 DescribeDesktops ,并根据其返回参数
ManagementFlags判断是否分配完成:ASSIGNING表示正在分配中,其他表示分配完成。建议每 2~5 秒检查一次是否分配完成,最多累计检查 50 秒。一般情况下,1~5 秒可完成分配。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ecd:BatchModifyEntitlement |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。 |
cn-hangzhou |
| MaxUserPerDesktop |
integer |
否 |
每台云电脑分配用户数量。 |
1 |
| MaxDesktopPerUser |
integer |
否 |
每个用户分配云电脑数量。 |
0 |
| Strategy |
string |
否 |
无法按比例匹配策略: AVERAGE:优先给每个用户分配云电脑,当所选云电脑数与用户数无法按比例匹配时,优先给每个用户分配云电脑。 CENTRAL:优先给用户分配指定数量的云电脑,当所选云电脑数与用户数无法按比例匹配时,优先给用户分配指定数量的云电脑。 枚举值:
|
AVERAGE |
| DesktopId |
array |
是 |
要修改授权用户的云电脑 ID 列表。 |
|
|
string |
否 |
要修改授权用户的云电脑 ID。 |
ecd-gx2x1dhsmucyy**** |
|
| EndUserId |
array |
否 |
用户 ID(即用户名)列表。 |
|
|
string |
否 |
用户 ID(即用户名)。 |
Alice |
|
| Preview |
boolean |
是 |
是否预览,预览不会真正分配。 |
true |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
51592A88-0F2C-55E6-AD2C-2AD9C10D**** |
| Entitlements |
object |
集合 |
|
| Status |
string |
整体分配结果。 枚举值:
|
FINISHED |
| TaskId |
string |
任务 ID |
B2F4F018-0EDF-159C-B285-117B5F1C**** |
| AssignModels |
array<object> |
分配结果集合 |
|
|
object |
|||
| DesktopId |
string |
云电脑 ID。 |
ecd-e94kzikmpljjx99pl |
| InnerStatus |
string |
单台云电脑分配结果 枚举值:
|
FINISHED |
| EndUserIds |
array |
云电脑授权的用户 ID(即用户名)列表。 |
|
|
string |
云电脑授权的用户 ID(即用户名) |
Alice |
示例
正常返回示例
JSON格式
{
"RequestId": "51592A88-0F2C-55E6-AD2C-2AD9C10D****",
"Entitlements": {
"Status": "FINISHED",
"TaskId": "B2F4F018-0EDF-159C-B285-117B5F1C****",
"AssignModels": [
{
"DesktopId": "ecd-e94kzikmpljjx99pl",
"InnerStatus": "FINISHED",
"EndUserIds": [
"Alice"
]
}
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。