すべてのプロダクト
Search

このプロダクト

    App Streaming:CreateImageByInstance

    ドキュメントセンター

    App Streaming:CreateImageByInstance

    最終更新日:Jul 04, 2026

    デプロイ済みの Wuying クラウドデスクトップからカスタムイメージを作成すると、同じ構成のデスクトップを迅速に追加作成できます。これにより、新しいインスタンスごとに環境を再構成する必要がなくなります。

    今すぐお試しください

    この 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:CreateImageByInstance

    create

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ImageName

    string

    任意

    イメージの名前。

    test
    Description

    string

    任意

    イメージの説明。

    my test image v1.0
    InstanceId

    string

    任意

    ソースとなる Elastic Desktop Service インスタンスの ID。インスタンスには、クラウドデスクトップまたはワークステーションを指定できます。データ整合性を確保するため、イメージを作成する前にインスタンスをシャットダウンすることを推奨します。

    ws-0buj1s9gm******
    SubInstanceId

    string

    任意

    サブインスタンスの ID。このパラメーターは、クラウドデスクトップインスタンスには適用されません。ワークステーションインスタンスの場合は、永続セッションの ID を指定します。

    p-0cc7s3n1l*****
    InstanceType

    string

    任意

    インスタンスタイプ。

    列挙値:

    • CloudDesktop :

      クラウドデスクトップ。

    • WuyingServer :

      ワークステーション。

    WuyingServer
    AutoCleanUserdata

    boolean

    任意

    ユーザーデータをクリアするかどうかを指定します。このパラメーターは、クラウドデスクトップインスタンスにのみ適用されます。true に設定すると、C:\Users 配下の Administrator および Public ディレクトリを除くすべてのディレクトリのデータがクリアされます。

    列挙値:

    • true :

      ユーザーデータをクリアします。

    • false :

      ユーザーデータをクリアしません。

    false
    DiskType

    string

    任意

    イメージに含めるディスクを指定します。デフォルトでは、システムディスクとデータディスクの両方が含まれます。

    列挙値:

    • SYSTEM :

      システムディスクのみ。

    • ALL :

      システムディスクとデータディスク。

    ALL
    BizType

    integer

    任意

    このパラメーターは内部利用のために予約されています。

    1
    ProductType

    string

    任意

    このパラメーターは内部利用のために予約されています。

    WuyingServer
    TagList

    array<object>

    任意

    object

    任意

    Key

    string

    任意

    Value

    string

    任意

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスボディ。

    Data

    object

    データオブジェクト。

    ImageId

    string

    Wuying イメージの ID。

    imgc-07hnjj5fp****
    VersionId

    string

    イメージバージョン。

    iv-0abxi0lbi*****
    TaskId

    string

    イメージ作成タスクの ID。

    tid-0abxi0lbih******
    Success

    boolean

    リクエストが成功したかどうかを示します。

    true
    Code

    string

    リクエストのステータスコード。

    200
    Message

    string

    リクエストが失敗した場合のエラーメッセージ。

    NULL
    RequestId

    string

    リクエスト ID。

    1CBAFFAB-B697-4049-A9B1-67E1FC5F****

    例

    成功レスポンス

    JSONJSON

    {
  "Data": {
    "ImageId": "imgc-07hnjj5fp****",
    "VersionId": "iv-0abxi0lbi*****",
    "TaskId": "tid-0abxi0lbih******"
  },
  "Success": true,
  "Code": "200",
  "Message": "NULL",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}

    エラーコード

    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.

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

    変更履歴

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