すべてのプロダクト
Search

このプロダクト

    App Streaming:ListAppInstanceGroup

    ドキュメントセンター

    App Streaming:ListAppInstanceGroup

    最終更新日:Jul 04, 2026

    複数のデリバリーグループの詳細を取得します。デリバリーグループを指定しない場合、このオペレーションは条件に一致するすべてのグループの詳細を返します。

    今すぐお試しください

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

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    PageSize

    integer

    任意

    各ページに返すエントリ数。最大値は 100 です。

    10
    PageNumber

    integer

    任意

    ページ番号。

    1
    Status

    array

    任意

    アプリインスタンスグループのステータス。

    string

    任意

    アプリインスタンスグループのステータス。

    列挙値:

    • PUBLISHED :

      公開済み

    • FAILED :

      公開失敗

    • MAINTAIN_FAILED :

      更新失敗

    • EXPIRED :

      期限切れ

    • MAINTAINING :

      更新中

    • CEASED :

      支払い遅延による停止

    • EXPIRED_RECYCLING :

      期限切れでリサイクル中

    • DEPLOYING :

      公開中

    "Status.1":"PUBLISHED","Status.2":"FAILED"
    AppInstanceGroupId

    string

    任意

    アプリインスタンスグループの ID。

    aig-9ciijz60n4xsv****
    ProductType

    string

    必須

    製品タイプ。

    列挙値:

    • CloudApp :

      Wuying クラウドアプリケーション

    CloudApp
    AppInstanceGroupName

    string

    任意

    アプリインスタンスグループの名前。このパラメーターはあいまい検索をサポートします。たとえば、このパラメーターを OfficeApps に設定すると、名前に OfficeApps を含む MyOfficeApps や OfficeApps A などのアプリインスタンスグループを返します。

    办公应用
    AppCenterImageId

    string

    任意

    アプリイメージの ID。Wuying クラウドアプリケーションコンソールの [イメージ管理] ページでイメージ ID を取得できます。

    img-8z4nztpaqvay4****
    RegionId deprecated

    string

    任意

    リージョン ID。

    cn-hangzhou
    BizRegionId

    string

    任意

    アプリインスタンスグループのリージョン ID。サポートされるリージョンの詳細については、「使用制限」をご参照ください。

    列挙値:

    • cn-shanghai :

      China (Shanghai)

    • cn-hangzhou :

      China (Hangzhou)

    cn-hangzhou
    NodeInstanceType

    string

    任意

    インスタンスタイプ。ListNodeInstanceType API を呼び出してインスタンスタイプを取得できます。

    appstreaming.vgpu.4c8g.2g
    OfficeSiteId

    string

    任意

    オフィスネットワークの ID。

    cn-hongkong+dir-643067****
    Tag

    array<object>

    任意

    タグ。

    object

    任意

    タグ。

    Key

    string

    任意

    タグキー。

    department
    Value

    string

    任意

    タグ値。

    design
    UserGroupIds

    array

    任意

    string

    任意

    ExcludedUserGroupIds

    array

    任意

    string

    任意

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返されるデータ。

    RequestId

    string

    リクエスト ID。

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

    integer

    エントリの総数。

    15
    PageSize

    integer

    1 ページあたりのエントリ数。

    10
    PageNumber

    integer

    ページ番号。

    1
    AppInstanceGroupModels

    array<object>

    アプリインスタンスグループの詳細。

    array<object>

    アプリインスタンスグループの詳細。

    Apps

    array<object>

    アプリインスタンスグループ内のアプリケーション。

    object

    アプリケーションの詳細。

    AppId

    string

    アプリケーション ID。

    ca-i87mycyn419nu****
    AppName

    string

    アプリケーション名。

    办公应用
    AppVersion

    string

    アプリケーションのバージョン。

    1.0.0
    AppVersionName

    string

    アプリケーションバージョンの名前。

    初始版本
    AppIcon

    string

    アプリケーションのアイコン。

    https://app-center-icon-****.png
    AppCenterImageId

    string

    アプリイメージの ID。

    img-8z4nztpaqvay4****
    RegionId

    string

    アプリインスタンスグループがあるリージョンの ID。サポートされているリージョンの詳細については、「制限」をご参照ください。

    cn-hangzhou
    ProductType

    string

    製品タイプ。

    列挙値:

    • CloudApp :

      Wuying Cloud Application

    CloudApp
    AppInstanceType

    string

    アプリインスタンスグループのインスタンスタイプ。

    __dynamic__
    AppInstanceGroupId

    string

    アプリインスタンスグループの ID。

    aig-9ciijz60n4xsv****
    Amount

    integer

    プロビジョニングされたサブスクリプションリソースの数。

    1
    MinAmount

    integer

    インスタンスの最小数。

    1
    MaxAmount

    integer

    インスタンスの最大数。

    10
    ReserveAmountRatio

    string

    予約するアイドルセッションの割合。有効な値：0～99。

    20
    ReserveMinAmount

    integer

    予約するアイドルセッションの最小数。

    1
    ReserveMaxAmount

    integer

    予約するアイドルセッションの最大数。

    5
    ScalingStep

    integer

    各スケールアウトイベントで作成されるセッションの数。

    10
    ScalingUsageThreshold

    string

    自動スケールアウトをトリガーするセッション使用率のしきい値 (%) 。セッション使用率がこのしきい値を超えると、自動スケールアウトがトリガーされます。セッション使用率は、次の式を使用して計算されます：(アクティブなセッション数 / セッションの総数) × 100%。有効な値：0～99。

    85
    ScalingDownAfterIdleMinutes

    integer

    スケールインがトリガーされるまでにリソースがアイドル状態 (セッション接続なし) でいられる時間 (分) 。最小値は 0 です。

    5
    ChargeType

    string

    課金方法。

    列挙値:

    • PostPaid :

      従量課金

    • PrePaid :

      サブスクリプション

    PrePaid
    GmtCreate

    string

    アプリインスタンスグループが作成された時刻。

    2022-04-26T15:06:16.000+00:00
    Status

    string

    アプリインスタンスグループのステータス。

    列挙値:

    • PUBLISHED :

      公開済み。

    • FAILED :

      公開失敗。

    • MAINTAIN_FAILED :

      更新失敗。

    • EXPIRED :

      期限切れ。

    • MAINTAINING :

      更新中。

    • CEASED :

      支払い遅延による停止。

    • EXPIRED_RECYCLING :

      期限切れでリサイクル中。

    • DEPLOYING :

      公開中。

    PUBLISHED
    NodePool

    array<object>

    アプリインスタンスグループ内のノードプール。

    array<object>

    ノードプールの詳細。

    NodePoolId

    string

    ノードプールの ID。

    rg-g6922kced36hx****
    NodeInstanceType

    string

    プール内のノードのインスタンスタイプ。

    appstreaming.vgpu.4c8g.2g
    NodeAmount

    integer

    ノードプール内の現在のサブスクリプションリソースの総数。

    1
    NodeUsed

    integer

    ノードプール内で使用中のサブスクリプションリソースの数。

    1
    NodeCapacity

    integer

    単一のリソースがホストできる同時セッションの数。値が高いとユーザーエクスペリエンスが低下する可能性があり、有効な値はリソース仕様によって異なります。

    2
    ScalingNodeAmount

    integer

    従量課金リソースの総数。

    8
    ScalingNodeUsed

    integer

    使用中の従量課金リソースの数。

    4
    StrategyType

    string

    スケーリングポリシーの種別。

    説明

    使用量ベースのスケーリングポリシー (NODE_SCALING_BY_USAGE) はサブスクリプションリソースにのみ適用されます。スケジュールベースのスケーリングポリシー (NODE_SCALING_BY_SCHEDULE) は従量課金リソースにのみ適用されます。

    列挙値:

    • NODE_FIXED :

      エラスティックリソースは使用されません。

    • NODE_SCALING_BY_SCHEDULE :

      スケジュールに基づくスケーリング

    • NODE_SCALING_BY_USAGE :

      使用量に基づくスケーリング

    NODE_FIXED
    Amount

    integer

    アプリインスタンスグループの作成時に購入された初期リソース数。

    2
    MaxScalingAmount

    integer

    単一のスケールアウトイベントで作成できるリソースの最大数。

    8
    MaxIdleAppInstanceAmount

    integer

    維持するアイドルセッションの最大数。指定した場合、セッション使用率が ScalingUsageThreshold を超え、かつアイドルセッション数が MaxIdleAppInstanceAmount 未満の場合にのみスケールアウトがトリガーされます。このパラメーターは、スケーリング動作を制御し、コストを削減するのに役立ちます。

    3
    ScalingStep

    integer

    各スケールアウトイベントで作成するリソースの数。有効な値：1～10。

    2
    ScalingUsageThreshold

    string

    自動スケールアウトをトリガーするセッション使用率 (%) 。使用率がこの値を超えると、スケールアウトが発生します。使用率は、式「セッション使用率 = (現在のセッション数 / (リソースの総数 × リソースあたりの同時セッション数)) × 100%」を使用して計算されます。

    85
    ScalingDownAfterIdleMinutes

    integer

    自動スケールインがトリガーされるまでリソースがアイドル状態でいられる時間 (分) 。デフォルト値：5。

    5
    RecurrenceSchedules

    array<object>

    スケーリングポリシーのスケジュール。

    array<object>

    スケーリングポリシーのスケジュール。

    RecurrenceType

    string

    スケジュールタスクの繰り返し種別。RecurrenceType と RecurrenceValues の両方を指定する必要があります。

    列挙値:

    • weekly :

      スケジュールタスクは、週の特定の曜日に繰り返されます。

    Weekly
    RecurrenceValues

    array

    繰り返しスケジュールの値。

    integer

    繰り返しスケジュールの値。

    列挙値:

    • 1 :

      月曜日

    • 2 :

      火曜日

    • 3 :

      水曜日

    • 4 :

      木曜日

    • 5 :

      金曜日

    • 6 :

      土曜日

    • 7 :

      日曜日

    1
    TimerPeriods

    array<object>

    ポリシーが有効な期間。

    object

    期間。

    Amount

    integer

    ターゲットリソース数。

    5
    EndTime

    string

    終了時刻 (HH:mm 形式)。

    11:00
    StartTime

    string

    開始時刻 (HH:mm 形式)。

    09:30
    StrategyDisableDate

    string

    ポリシーが無効になる日付 (yyyy-MM-dd 形式)。

    2022-09-08
    StrategyEnableDate

    string

    ポリシーが有効になる日付 (yyyy-MM-dd 形式)。

    2022-08-01
    WarmUp

    boolean

    リソースウォームアップポリシーが有効になっているかどうかを示します。

    false
    NodeTypeName

    string

    リソース仕様の名前。

    无影-通用型_4核8G
    SpecId

    string

    アプリインスタンスグループ ID に一対一でマッピングされる一意の ID。

    spec-8o18t8uc31qib0****
    SessionTimeout

    string

    ユーザーが切断した後のセッション維持時間 (分) 。この時間が経過すると、セッションは終了します。セッションを無期限に維持するには、この値を -1 に設定します。有効な値：-1 または 3～300。デフォルト：15。

    15
    AppInstanceGroupName

    string

    アプリインスタンスグループの名前。

    办公应用
    ExpiredTime

    string

    アプリインスタンスグループの有効期限が切れる時刻。

    2022-04-27T16:00:00.000+00:00
    OtaInfo

    object

    OTA 更新タスクの詳細。

    OtaVersion

    string

    現在の OTA バージョン。

    0.0.1-D-20220615.11****
    NewOtaVersion

    string

    新しい OTA バージョン。空の値は、新しいバージョンが利用できないことを示します。

    0.0.1-D-20220630.11****
    TaskId

    string

    OTA 更新タスクの ID。

    ota-e49929gv8acz5****
    OsType

    string

    オペレーティングシステム。

    列挙値:

    • Windows :

      Windows

    Windows
    ResourceStatus

    string

    リソースのステータス。

    列挙値:

    • AVAILABLE :

      利用可能

    • RELEASED :

      リリース済み

    • EXPIRED_IN_7_DAYS :

      7日以内に有効期限切れ

    • UNAVAILABLE :

      利用不可

    • UPGRADING :

      更新中

    • CREATING :

      作成中

    AVAILABLE
    AppPolicyId

    string

    ポリシー ID。

    pg-g3k5wa2ms2****
    ChargeResourceMode

    string

    リソースの課金モデル。

    列挙値:

    • AppInstance :

      セッション単位の課金

    • Node :

      リソース単位の課金

    Node
    SkipUserAuthCheck

    boolean

    ユーザー承認をスキップするかどうか。

    列挙値:

    • true :

      ユーザー承認はスキップされます。

    • false :

      ユーザー承認が検証されます。これがデフォルト値です。

    false
    OfficeSiteId

    string

    オフィスネットワークの ID。

    cn-beijing+dir-172301****

    AppPolicyVersion

    string

    ポリシーのバージョン。

    列挙値:

    • CENTER :

      統一ポリシー (新規)

    • DEFAULT :

      デフォルトポリシー (レガシー)

    CENTER
    AppPolicyImageCheck

    boolean

    現在のイメージが統一ポリシーをサポートしているかどうか。

    列挙値:

    • true :

      サポートされています

    • false :

      サポートされていません

    false
    ResourceTags

    array<object>

    リソースにアタッチされたタグ。

    object

    リソースタグ。

    Key

    string

    タグキー。

    department
    Value

    string

    タグ値。

    design
    Scope

    string

    タグの種別。

    列挙値:

    • Custom :

      カスタムタグ

    • System :

      システムタグ

    Custom
    Tags

    array<object>

    リソースにアタッチされたタグ。

    object

    リソースタグ。

    Key

    string

    タグキー。

    department
    Value

    string

    タグ値。

    design
    Scope

    string

    タグの種別。

    列挙値:

    • Custom :

      カスタムタグ

    • System :

      システムタグ

    Custom
    AuthMode

    string

    承認モデル。

    列挙値:

    • App :

      アプリケーションベースの承認

    • AppInstanceGroup :

      アプリインスタンスグループベースの承認

    • Session :

      セッションベースの承認

    App
    AccessType

    string

    アクセスタイプ。

    列挙値:

    • INTERNET :

      インターネット

    • VPC :

      Virtual Private Cloud (VPC)

    • ANY :

      インターネットと Virtual Private Cloud (VPC)

    INTERNET
    SupportUserGroupMixedAuth

    boolean

    UserGroupAuthMode

    string

    Mixed

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "TotalCount": 15,
  "PageSize": 10,
  "PageNumber": 1,
  "AppInstanceGroupModels": [
    {
      "Apps": [
        {
          "AppId": "ca-i87mycyn419nu****",
          "AppName": "办公应用",
          "AppVersion": "1.0.0",
          "AppVersionName": "初始版本",
          "AppIcon": "https://app-center-icon-****.png"
        }
      ],
      "AppCenterImageId": "img-8z4nztpaqvay4****",
      "RegionId": "cn-hangzhou",
      "ProductType": "CloudApp",
      "AppInstanceType": "__dynamic__",
      "AppInstanceGroupId": "aig-9ciijz60n4xsv****",
      "Amount": 1,
      "MinAmount": 1,
      "MaxAmount": 10,
      "ReserveAmountRatio": "20",
      "ReserveMinAmount": 1,
      "ReserveMaxAmount": 5,
      "ScalingStep": 10,
      "ScalingUsageThreshold": "85",
      "ScalingDownAfterIdleMinutes": 5,
      "ChargeType": "PrePaid",
      "GmtCreate": "2022-04-26T15:06:16.000+00:00",
      "Status": "PUBLISHED",
      "NodePool": [
        {
          "NodePoolId": "rg-g6922kced36hx****",
          "NodeInstanceType": "appstreaming.vgpu.4c8g.2g",
          "NodeAmount": 1,
          "NodeUsed": 1,
          "NodeCapacity": 2,
          "ScalingNodeAmount": 8,
          "ScalingNodeUsed": 4,
          "StrategyType": "NODE_FIXED",
          "Amount": 2,
          "MaxScalingAmount": 8,
          "MaxIdleAppInstanceAmount": 3,
          "ScalingStep": 2,
          "ScalingUsageThreshold": "85",
          "ScalingDownAfterIdleMinutes": 5,
          "RecurrenceSchedules": [
            {
              "RecurrenceType": "Weekly",
              "RecurrenceValues": [
                1
              ],
              "TimerPeriods": [
                {
                  "Amount": 5,
                  "EndTime": "11:00",
                  "StartTime": "09:30"
                }
              ]
            }
          ],
          "StrategyDisableDate": "2022-09-08",
          "StrategyEnableDate": "2022-08-01",
          "WarmUp": false,
          "NodeTypeName": "无影-通用型_4核8G"
        }
      ],
      "SpecId": "spec-8o18t8uc31qib0****",
      "SessionTimeout": "15",
      "AppInstanceGroupName": "办公应用",
      "ExpiredTime": "2022-04-27T16:00:00.000+00:00",
      "OtaInfo": {
        "OtaVersion": "0.0.1-D-20220615.11****",
        "NewOtaVersion": "0.0.1-D-20220630.11****",
        "TaskId": "ota-e49929gv8acz5****"
      },
      "OsType": "Windows",
      "ResourceStatus": "AVAILABLE",
      "AppPolicyId": "pg-g3k5wa2ms2****",
      "ChargeResourceMode": "Node",
      "SkipUserAuthCheck": false,
      "OfficeSiteId": "cn-beijing+dir-172301****\n",
      "AppPolicyVersion": "CENTER",
      "AppPolicyImageCheck": false,
      "ResourceTags": [
        {
          "Key": "department",
          "Value": "design",
          "Scope": "Custom"
        }
      ],
      "Tags": [
        {
          "Key": "department",
          "Value": "design",
          "Scope": "Custom"
        }
      ],
      "AuthMode": "App",
      "AccessType": "INTERNET",
      "SupportUserGroupMixedAuth": false,
      "UserGroupAuthMode": "Mixed"
    }
  ]
}

    エラーコード

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

    変更履歴

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