BatchModifyEntitlement - 批量修改云电脑的用户授权

批量分配用户到多台云电脑

接口说明

  • 云电脑的状态必须为运行中(Running)。
  • 本接口立刻返回结果,如需查询分配是否成功,请调用 DescribeDesktops ,并根据其返回参数ManagementFlags判断是否分配完成:ASSIGNING表示正在分配中,其他表示分配完成。
  • 建议每 2~5 秒检查一次是否分配完成,最多累计检查 50 秒。一般情况下,1~5 秒可完成分配。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecd:BatchModifyEntitlement
*全部资源
*

请求参数

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

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

cn-hangzhou
MaxUserPerDesktopinteger

每台云电脑分配用户数量。

1
MaxDesktopPerUserinteger

每个用户分配云电脑数量。

0
Strategystring

无法按比例匹配策略:

AVERAGE:优先给每个用户分配云电脑,当所选云电脑数与用户数无法按比例匹配时,优先给每个用户分配云电脑。

CENTRAL:优先给用户分配指定数量的云电脑,当所选云电脑数与用户数无法按比例匹配时,优先给用户分配指定数量的云电脑。

AVERAGE
DesktopIdarray

要修改授权用户的云电脑 ID 列表。

string

要修改授权用户的云电脑 ID。

ecd-gx2x1dhsmucyy****
EndUserIdarray

用户 ID(即用户名)列表。

string

用户 ID(即用户名)。

Alice
Previewboolean

是否预览,预览不会真正分配。

true

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

51592A88-0F2C-55E6-AD2C-2AD9C10D****
Entitlementsobject

集合

Statusstring

整体分配结果。

枚举值:
  • FAILEDFAILED
  • NOT_STARTEDNOT_STARTED
  • STARTEDSTARTED
  • PROCESSINGPROCESSING
  • FINISHEDFINISHED
FINISHED
TaskIdstring

任务 ID

B2F4F018-0EDF-159C-B285-117B5F1C****
AssignModelsarray<object>

分配结果集合

AssignModelobject
DesktopIdstring

云电脑 ID。

ecd-e94kzikmpljjx99pl
InnerStatusstring

单台云电脑分配结果

枚举值:
  • FAILEDFAILED
  • NOT_STARTEDNOT_STARTED
  • STARTEDSTARTED
  • PROCESSINGPROCESSING
  • FINISHEDFINISHED
FINISHED
EndUserIdsarray

云电脑授权的用户 ID(即用户名)列表。

EndUserIdstring

云电脑授权的用户 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"
        ]
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2025-11-14新增 OpenAPI查看变更详情