すべてのプロダクト
Search
ドキュメントセンター

Elastic Desktop Service:BatchModifyEntitlement

最終更新日:Aug 02, 2026

複数のクラウドコンピューターにユーザーをバッチで割り当てます。

操作説明

  • クラウドコンピューターは実行中状態である必要があります。

  • この操作はすぐに結果を返します。割り当てが成功したかどうかを確認するには、 DescribeDesktops を呼び出し、レスポンスパラメーター ManagementFlags を確認します。ASSIGNING は割り当てが進行中であることを示し、それ以外の値は割り当てが完了していることを示します。

  • 割り当てが完了したかどうかを 2~5 秒ごとに確認し、最大 50 秒間待機してください。通常、割り当ては 1~5 秒以内に完了します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ecd:BatchModifyEntitlement

update

*すべてのリソース。

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

RegionId

string

必須

リージョン ID。DescribeRegions を呼び出して、Elastic Desktop サービス (EDS) でサポートされているリージョンをクエリできます。

cn-hangzhou

MaxUserPerDesktop

integer

任意

各クラウドコンピューターに割り当てるユーザー数。

1

MaxDesktopPerUser

integer

任意

各ユーザーに割り当てるクラウドコンピューター数。

0

Strategy

string

任意

クラウドコンピューターとユーザーの比率を均等に割り当てられない場合に使用するポリシー。有効な値:

  • AVERAGE: 各ユーザーへのクラウドコンピューターの割り当てを優先します。選択されたクラウドコンピューターとユーザーの数を均等に割り当てられない場合、システムは各ユーザーへのクラウドコンピューターの割り当てを優先します。

  • CENTRAL: ユーザーへの指定された数のクラウドコンピューターの割り当てを優先します。選択されたクラウドコンピューターとユーザーの数を均等に割り当てられない場合、システムはユーザーへの指定された数のクラウドコンピューターの割り当てを優先します。

列挙値:

  • AVERAGE :

    AVERAGE。

  • CENTRAL :

    CENTRAL。

AVERAGE

DesktopId

array

必須

権限付与されたユーザーを更新するクラウドコンピューターの ID。

string

任意

権限付与されたユーザーを更新するクラウドコンピューターの ID。

ecd-gx2x1dhsmucyy****

EndUserId

array

任意

ユーザー ID (ユーザー名)。

string

任意

ユーザー ID (ユーザー名)。

Alice

Preview

boolean

必須

割り当てをプレビューするかどうかを指定します。このパラメーターを true に設定した場合、実際の割り当ては実行されません。

true

レスポンスフィールド

フィールド

説明

object

RequestId

string

リクエスト ID。

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

Entitlements

object

割り当て結果。

Status

string

全体的な割り当て結果。

列挙値:

  • FAILED :

    FAILED。

  • NOT_STARTED :

    NOT_STARTED。

  • STARTED :

    STARTED。

  • PROCESSING :

    PROCESSING。

  • FINISHED :

    FINISHED。

FINISHED

TaskId

string

タスク ID。

B2F4F018-0EDF-159C-B285-117B5F1C****

AssignModels

array<object>

割り当て結果の詳細。

object

DesktopId

string

クラウドコンピューター ID。

ecd-e94kzikmpljjx99pl。

InnerStatus

string

単一のクラウドコンピューターの割り当て結果。

列挙値:

  • FAILED :

    FAILED。

  • NOT_STARTED :

    NOT_STARTED。

  • STARTED :

    STARTED。

  • PROCESSING :

    PROCESSING。

  • FINISHED :

    FINISHED。

FINISHED。

EndUserIds

array

クラウドコンピューターに対して権限が付与されたユーザー ID (ユーザー名)。

string

クラウドコンピューターに対して権限が付与されたユーザー ID (ユーザー名)。

Alice。

成功レスポンス

JSONJSON

{
  "RequestId": "51592A88-0F2C-55E6-AD2C-2AD9C10D****",
  "Entitlements": {
    "Status": "FINISHED。",
    "TaskId": "B2F4F018-0EDF-159C-B285-117B5F1C****",
    "AssignModels": [
      {
        "DesktopId": "ecd-e94kzikmpljjx99pl。",
        "InnerStatus": "FINISHED。",
        "EndUserIds": [
          "Alice。"
        ]
      }
    ]
  }
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。