すべてのプロダクト
Search

このプロダクト

    App Streaming:ListAppInstanceGroup

    ドキュメントセンター

    App Streaming:ListAppInstanceGroup

    最終更新日:Sep 17, 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

    *すべてのリソース。

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    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 Workspace クラウドアプリケーション。

    CloudApp
    AppInstanceGroupName

    string

    任意

    配信グループ名。クエリにはあいまい一致が使用されます。たとえば、配信グループ名を OfficeApp に設定すると、MyOfficeApp や OfficeAppA など、名前に OfficeApp を含むすべての配信グループが返されます。

    OfficeApp
    AppCenterImageId

    string

    任意

    アプリケーションイメージの ID。この値は、WUYING Workspace コンソールのイメージ管理ページから取得できます。

    img-8z4nztpaqvay4****
    RegionId deprecated

    string

    任意

    リージョン ID。

    cn-hangzhou
    BizRegionId

    string

    任意

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

    列挙値:

    • cn-shanghai :

      中国 (上海)

    • cn-hangzhou :

      中国 (杭州)

    cn-hangzhou
    NodeInstanceType

    string

    任意

    購入したリソースの仕様タイプ ID。この値を取得するには、 ListNodeInstanceType 操作を呼び出します。

    appstreaming.vgpu.4c8g.2g
    OfficeSiteId

    string

    任意

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

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

    array<object>

    任意

    タグのリスト。

    object

    任意

    タグ。

    Key

    string

    任意

    タグキー。

    department
    Value

    string

    任意

    タグ値。

    design
    UserGroupIds

    array

    任意

    許可されるユーザーグループの ID のリスト。

    string

    任意

    許可されるユーザーグループの ID。

    user_001
    ExcludedUserGroupIds

    array

    任意

    除外される許可されるユーザーグループの ID のリスト。

    string

    任意

    除外される許可されるユーザーグループの ID。

    ug-0001

    レスポンスフィールド

    フィールド

    型

    説明

    例

    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

    アプリケーション名。

    OfficeApp
    AppVersion

    string

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

    1.0.0
    AppVersionName

    string

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

    初期バージョン
    AppIcon

    string

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

    https://app-センター-アイコン-****.png
    AppCenterImageId

    string

    アプリケーションイメージの ID。

    img-8z4nztpaqvay4****
    RegionId

    string

    配信グループのリージョン ID のフォーマット。サポートされているリージョンの詳細については、「使用制限」を参照してください。

    cn-hangzhou
    ProductType

    string

    プロダクトタイプ。

    列挙値:

    • CloudApp :

      WUYING Workspace クラウドアプリケーション。

    CloudApp
    AppInstanceType

    string

    配信グループの仕様タイプ。

    __dynamic__
    AppInstanceGroupId

    string

    配信グループの ID。

    aig-9ciijz60n4xsv****
    Amount

    integer

    ユーザーが設定したサブスクリプションリソースの数。最小値: 1。

    1
    MinAmount

    integer

    インスタンスの最小数。最小値: 1。

    1
    MaxAmount

    integer

    インスタンスの最大数。最小値: 1。

    10
    ReserveAmountRatio

    string

    予約済みインスタンスの割合 (タグ)。配信グループ内の未使用の会話の比率です。有効な値: 0～99。

    20
    ReserveMinAmount

    integer

    予約インスタンスの最小数。これは、配信グループ内の未使用セッションの最小数です。最小値: 1。

    1
    ReserveMaxAmount

    integer

    予約済みインスタンスの最大数。これは配信グループ内の未使用セッションの最大数です。最小値: 1。

    5
    ScalingStep

    integer

    スケールアウト操作ごとに作成される会話数。最小値: 1。

    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

    購入したリソースの仕様タイプ ID。

    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 (使用量ベースのスケーリングポリシー) は PrePaid (サブスクリプション) リソースにのみ適用されます。NODE_SCALING_BY_SCHEDULE (スケジュールされたスケーリングポリシー) は PostPaid (従量課金) リソースにのみ適用されます。

    列挙値:

    • 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

    リソース仕様の名前。

    WUYING-General_4vCPU8GiB
    SpecId

    string

    配信グループ ID に一意に対応する ID。

    spec-8o18t8uc31qib0****
    SessionTimeout

    string

    切断された会話が保持される持続時間 (分単位)。エンドユーザーの会話が切断された後、ここで指定された持続時間会話が保持され、その後ログオフされます。このパラメーターを -1 に設定すると、会話が無期限に保持されます。有効な値: -1、および 3～300。デフォルト値: 15。

    15
    AppInstanceGroupName

    string

    配信グループの名前。

    OfficeApp
    ExpiredTime

    string

    配信グループの有効期限の時間。値は ISO 8601 日時フォーマットで、ミリ秒とタイムゾーンオフセットを含みます。フォーマット: yyyy-MM-dd'T'HH:mm:ss.SSSXXX。

    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 :

      エンタープライズプライベートネットワーク (VPC)

    • ANY :

      インターネットおよびエンタープライズプライベートネットワーク (VPC)

    INTERNET
    SupportUserGroupMixedAuth

    boolean

    ユーザーとユーザーグループの混合権限付与がサポートされているかどうかを示します。

    UserGroupAuthMode

    string

    ユーザーおよびユーザーグループの権限付与モード。

    列挙値:

    • User :

      個別ユーザーの権限付与のみがサポートされます。これは、SupportUserGroupMixedAuth が false に設定されており、個別ユーザーにすでに権限が付与されていることを示します。

    • Mixed :

      ユーザーグループと個別ユーザーの両方がサポートされます。1. SupportUserGroupMixedAuth が true に設定されている場合、配信グループのこの属性は常に Mixed になります。2. SupportUserGroupMixedAuth が false に設定されている場合、ユーザーまたはユーザーグループには権限が付与されていません。

    • UserGroup :

      ユーザーグループの権限付与のみがサポートされます。これは、SupportUserGroupMixedAuth が false に設定されており、ユーザーグループにすでに権限が付与されていることを示します。

    混合

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "TotalCount": 15,
  "PageSize": 10,
  "PageNumber": 1,
  "AppInstanceGroupModels": [
    {
      "Apps": [
        {
          "AppId": "ca-i87mycyn419nu****",
          "AppName": "OfficeApp.",
          "AppVersion": "1.0.0",
          "AppVersionName": "Initial version.",
          "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": true,
          "NodeTypeName": "WUYING-General_4vCPU8GiB."
        }
      ],
      "SpecId": "spec-8o18t8uc31qib0****",
      "SessionTimeout": "15",
      "AppInstanceGroupName": "OfficeApp.",
      "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": true,
      "OfficeSiteId": "cn-beijing+dir-172301****",
      "AppPolicyVersion": "CENTER。",
      "AppPolicyImageCheck": true,
      "ResourceTags": [
        {
          "Key": "department。",
          "Value": "design。",
          "Scope": "Custom。"
        }
      ],
      "Tags": [
        {
          "Key": "department。",
          "Value": "design。",
          "Scope": "Custom。"
        }
      ],
      "AuthMode": "App。",
      "AccessType": "INTERNET。",
      "SupportUserGroupMixedAuth": false,
      "UserGroupAuthMode": "Mixed。"
    }
  ]
}

    エラーコード

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

    変更履歴

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