API でユーザーを масово にクラウドコンピュータを割り当て - Elastic Desktop Service

複数の WUYING Workspace にユーザーを一括で割り当てます。

操作説明

WUYING Workspace は「実行中」状態である必要があります。
この操作はすぐに結果を返します。割り当てが成功したかどうかを確認するには、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

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。WUYING Workspace をサポートするリージョンのリストを取得するには、DescribeRegions を呼び出します。	cn-hangzhou
MaxUserPerDesktop	integer	任意	各クラウドデスクトップに割り当てるユーザー数。	1
MaxDesktopPerUser	integer	任意	各ユーザーに割り当てる WUYING Workspace の数。	0
Strategy	string	任意	ワークスペースの数とユーザーの数が比例して一致しない場合の割り当てを処理するためのポリシーです。 AVERAGE: システムは、各ユーザーに少なくとも 1 つのワークスペースを割り当てることを優先します。 CENTRAL: システムは、各ユーザーに指定された数のワークスペースを割り当てることを優先します。列挙値: AVERAGE : AVERAGE CENTRAL : CENTRAL	AVERAGE
DesktopId	array	必須	ユーザーの割り当てを変更する WUYING Workspace の ID。
	string	任意	ユーザーの割り当てを変更する WUYING Workspace の ID。	ecd-gx2x1dhsmucyy****
EndUserId	array	任意	ユーザー ID のリスト。ユーザー ID はユーザー名と同じです。
	string	任意	ユーザー ID。ユーザー 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	単一の WUYING Workspace の割り当て結果。列挙値: FAILED : FAILED NOT_STARTED : NOT_STARTED STARTED : STARTED PROCESSING : PROCESSING FINISHED : FINISHED	FINISHED
EndUserIds	array	WUYING Workspace に権限が付与されたユーザー ID のリスト。ユーザー ID はユーザー名と同じです。
	string	WUYING Workspace に権限が付与されたユーザー ID。ユーザー 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"
        ]
      }
    ]
  }
}

エラーコード

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

変更履歴

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