StartTaskForDistributeImage - App Streaming - Alibaba Cloud ドキュメントセンター

イメージを他の複数のリージョンにコピーするタスクを開始します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

appstreaming:StartTaskForDistributeImage

create

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ImageId	string	必須	イメージ ID。	imgc-07jyldnd9i*****
VersionId	string	任意	イメージバージョン ID。このパラメーターを指定しない場合、最新のイメージバージョンが使用されます。	iv-07jyldnd9i****
RetryType	string	任意	このパラメーターは公開されていません。	RETRY
DestinationRegionList	array	任意	イメージをコピーする送信先リージョンのリスト。
	string	任意	Alibaba Cloud のリージョン ID。	cn-hangzhou
ProductType	string	任意	製品タイプ。列挙値: CloudDesktop : WUYING Workspace。 CloudApp : WUYING CloudApp。 WuyingServer : WUYING Workstation。	CloudApp
SourceRegion	string	任意	イメージのソースリージョン。このパラメーターを指定しない場合、ランダムなリージョンが選択されます。	cn-shanghai

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンス構造体。
Data	string	イメージコピータスクの ID。	tid-06xnr5lyp77e7****
Success	boolean	リクエストが成功したかどうか。	true
Code	string	リクエストの成否を示すステータスコード。	200
Message	string	返されたメッセージ。	success
RequestId	string	リクエスト ID。	419F31B9-1FDF-5644-ABA3-D00026FA****

例

成功レスポンス

JSONJSON

{
  "Data": "tid-06xnr5lyp77e7****",
  "Success": true,
  "Code": "200",
  "Message": "success",
  "RequestId": "419F31B9-1FDF-5644-ABA3-D00026FA****"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	Instance.NotFound	The instance is not found.
400	DesktopInstance.NotFound	The cloud computer instance does not exist.
400	Instance.ImageUnsupported	A non-centralized image does not support this type of operation.
400	Instance.PhysicalNodeNotExist	The instance physical node does not exist.
400	ImageCreateByInstance.TaskExist	The image task of instance creation already exists.
400	ExceedBuilderQuota	The maximum number of builders is reached.
400	InvalidBaseImage.NotConfigured	Configuration required for Vhd/Container images.
400	CreateDesktopImageRecord.Failed	Create cloud computer image failed.
400	Image.NotExist	The image does not exist.
400	ImageRegionDistribute.NotAllow	This image cannot be distributed.
400	ImageUpdateFailed.NotAllow	The image is not allowed to be modified.
400	ImageUpdateSharedImageFailed.NotAllow	The shared image is not allowed to be modified.
400	ParentImageRegionDistribute.NotExist	The target distribution region of the parent image does not exist.
400	InternalError	Internal error.
400	ImageDistribute.TargetDistributeRegionListEmpty	The target distribution region list is empty.
400	ImageDistribute.ImageNotSupport	The image does not support region distribution.
400	ImageDistribute.RepeatedDistribution	This image has been distributed to this region.
400	ImageDistribute.Undistributed	The image has not been distributed to any region.
400	ImageRegion.NotConfigured	The image does not have any region configuration.

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

変更履歴

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