All Products
Search
Document Center

App Streaming:GetAppInstanceGroup

Last Updated:Jul 04, 2026

Mengambil detail delivery group tertentu.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

  • Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.

  • API: API yang dapat Anda panggil untuk melakukan aksi tersebut.

  • Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.

  • Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.

    • Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.

    • Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.

  • Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.

  • Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

appstreaming:GetAppInstanceGroup

get

*全部资源

*

None None

Parameter permintaan

Parameter

Type

Required

Description

Example

AppInstanceGroupId

string

Yes

ID dari delivery group. Panggil operasi ListAppInstanceGroup untuk mendapatkan ID tersebut.

aig-9ciijz60n4xsv****

ProductType

string

Yes

Tipe produk.

Valid values:

  • CloudApp :

    Cloud App

CloudApp

Elemen respons

Element

Type

Description

Example

object

Data yang dikembalikan.

RequestId

string

ID permintaan.

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

AppInstanceGroupModels

object

Detail dari app instance group.

Apps

array<object>

Daftar aplikasi.

object

Detail aplikasi.

AppId

string

ID aplikasi.

ca-i87mycyn419nu****

AppName

string

Nama aplikasi.

办公应用

AppVersion

string

Versi aplikasi.

1.0.0

AppVersionName

string

Nama versi aplikasi.

初始版本

AppIcon

string

URL ikon aplikasi.

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

AppCenterImageId

string

ID gambar aplikasi.

img-8z4nztpaqvay4****

RegionId

string

ID wilayah tempat app instance group berada. Untuk daftar wilayah yang didukung, lihat Limits .

cn-hangzhou

ProductType

string

Tipe produk.

CloudApp

AppInstanceType

string

Tipe instans dari app instance group.

__dynamic__

AppInstanceTypeName

string

Nama tipe instans aplikasi.

test001

AppInstanceGroupId

string

ID app instance group.

aig-9ciijz60n4xsv****

Amount

integer

Jumlah resource yang termasuk dalam Subscription. Nilai minimum adalah 1.

1

MinAmount

integer

Jumlah minimum instans. Nilai minimum adalah 1.

1

MaxAmount

integer

Jumlah maksimum instans.

10

ReserveAmountRatio

string

Persentase sesi idle yang dicadangkan dalam app instance group. Nilai valid: 0 hingga 99.

20

ReserveMinAmount

integer

Jumlah minimum sesi idle yang dicadangkan dalam app instance group. Nilainya harus 1 atau lebih.

1

ReserveMaxAmount

integer

Jumlah maksimum sesi idle yang dicadangkan dalam app instance group. Nilainya harus 1 atau lebih.

5

ScalingStep

integer

Jumlah sesi yang ditambahkan pada setiap event scale-out. Nilai minimum adalah 1.

10

ScalingUsageThreshold

string

Ambang batas penggunaan sesi, dalam persentase, yang memicu scale-out. Scale-out dipicu ketika penggunaan sesi, dihitung sebagai (Jumlah sesi aktif / Jumlah total sesi) × 100% , melebihi ambang batas ini. Nilai valid: 0 hingga 99.

85

ScalingDownAfterIdleMinutes

integer

Jumlah menit sebuah resource harus idle sebelum scale-in dipicu. Resource dianggap idle jika tidak memiliki koneksi sesi aktif. Nilai minimum adalah 0.

5

ChargeType

string

Metode penagihan.

Valid values:

  • PostPaid :

    Pay-As-You-Go

  • PrePaid :

    Subscription

PrePaid

ChargeResourceMode

string

Model penagihan.

Valid values:

  • AppInstance :

    Penagihan per sesi

  • Node :

    Penagihan per resource

Node

GmtCreate

string

Waktu saat app instance group dibuat.

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

Status

string

Status app instance group.

Valid values:

  • PUBLISHED :

    Published

  • FAILED :

    Publication failed

  • MAINTAIN_FAILED :

    Update failed

  • EXPIRED :

    Expired

  • MAINTAINING :

    Updating

  • CEASED :

    Payment overdue

  • EXPIRED_RECYCLING :

    Expired and being recycled

  • DEPLOYING :

    Publishing

PUBLISHED

NodePool

array<object>

Informasi tentang kelompok node.

array<object>

Informasi tentang kelompok node.

NodePoolId

string

ID kelompok node.

rg-g6922kced36hx****

NodeInstanceType

string

Tipe instans dari resource yang dibeli.

appstreaming.vgpu.4c8g.2g

NodeAmount

integer

Jumlah total resource Subscription.

1

NodeUsed

integer

Jumlah resource Subscription yang sedang digunakan.

1

NodeCapacity

integer

Jumlah sesi konkuren yang dapat didukung oleh satu resource. Melebihi kapasitas ini dapat menurunkan performa aplikasi. Nilai valid tergantung pada spesifikasi resource. Daftar berikut menjelaskan nilai valid untuk spesifikasi resource yang berbeda:

  • appstreaming.general.4c8g: 1 hingga 2

  • appstreaming.general.8c16g: 1 hingga 4

  • appstreaming.vgpu.8c16g.4g: 1 hingga 4

  • appstreaming.vgpu.8c31g.16g: 1 hingga 4

  • appstreaming.vgpu.14c93g.12g: 1 hingga 6

2

ScalingNodeAmount

integer

Jumlah total resource auto-scaled.

8

ScalingNodeUsed

integer

Jumlah resource auto-scaled yang sedang digunakan.

4

StrategyType

string

Tipe kebijakan penskalaan.

Catatan

Kebijakan NODE_SCALING_BY_USAGE (penskalaan berbasis penggunaan) hanya berlaku untuk resource PrePaid (Subscription). Kebijakan NODE_SCALING_BY_SCHEDULE (penjadwalan penskalaan) hanya berlaku untuk resource PostPaid (Pay-As-You-Go).

Valid values:

  • NODE_FIXED :

    Auto scaling dinonaktifkan.

  • NODE_SCALING_BY_SCHEDULE :

    Penjadwalan penskalaan

  • NODE_SCALING_BY_USAGE :

    Penskalaan berbasis penggunaan

NODE_FIXED

Amount

integer

Jumlah awal resource yang dibeli.

2

MaxScalingAmount

integer

Jumlah maksimum resource yang dapat dibuat dalam event scale-out.

8

MaxIdleAppInstanceAmount

integer

Jumlah maksimum sesi idle. Jika Anda menentukan parameter ini, scale-out hanya dipicu ketika penggunaan sesi melebihi nilai ScalingUsageThreshold dan jumlah sesi idle dalam app instance group kurang dari nilai MaxIdleAppInstanceAmount . Hal ini memastikan scale-out hanya dipicu ketika sesi idle tidak mencukupi, membantu Anda mengontrol perilaku penskalaan dan mengurangi biaya.

3

ScalingStep

integer

Jumlah resource yang dibuat dalam setiap event scale-out. Nilai valid: 1 hingga 10.

2

ScalingUsageThreshold

string

Ambang batas penggunaan sesi, dalam persentase, yang memicu scale-out. Scale-out dipicu ketika penggunaan sesi, dihitung sebagai Jumlah sesi saat ini / (Jumlah total resource × Jumlah sesi konkuren per resource) × 100% , melebihi ambang batas ini.

85

ScalingDownAfterIdleMinutes

integer

Jumlah menit sebuah resource harus tetap idle sebelum scale-in dipicu. Resource dianggap idle jika tidak memiliki koneksi sesi. Nilai default: 5.

5

RecurrenceSchedules

array<object>

Jadwal berulang.

array<object>

Jadwal berulang.

RecurrenceType

string

Tipe pengulangan dari tugas terjadwal. Anda harus menentukan baik RecurrenceType maupun RecurrenceValues .

Weekly

RecurrenceValues

array

Nilai pengulangan dari tugas terjadwal.

integer

Nilai pengulangan dari tugas terjadwal.

1

TimerPeriods

array<object>

Periode waktu dari jadwal berulang.

object

Periode waktu dari jadwal berulang.

Amount

integer

Jumlah target resource.

5

EndTime

string

Waktu berakhir dalam format HH:mm.

11:00

StartTime

string

Waktu mulai dalam format HH:mm.

09:30

StrategyDisableDate

string

Tanggal kebijakan menjadi tidak efektif. Tanggal harus dalam format yyyy-MM-dd.

2022-09-08

StrategyEnableDate

string

Tanggal kebijakan mulai berlaku. Tanggal harus dalam format yyyy-MM-dd.

2022-08-01

WarmUp

boolean

Menunjukkan apakah kebijakan warm-up resource diaktifkan.

false

NodeTypeName

string

Nama spesifikasi resource.

无影-通用型_4核8G

SpecId

string

ID spesifikasi dari app instance group.

spec-8o18t8uc31qib0****

SessionTimeout

string

Durasi, dalam menit, sesi yang terputus tetap aktif sebelum ditutup. Untuk menjaga sesi tetap aktif tanpa batas waktu, atur parameter ini ke -1 . Nilai valid: -1 dan 3 hingga 300. Default: 15 .

15

AppInstanceGroupName

string

Nama app instance group.

办公应用

ExpiredTime

string

Waktu saat app instance group kedaluwarsa.

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

OtaInfo

object

Informasi tentang tugas Pembaruan OTA.

OtaVersion

string

Versi OTA saat ini.

0.0.1-D-20220615.11****

NewOtaVersion

string

Versi OTA baru. Nilai kosong menunjukkan bahwa tidak ada versi baru yang tersedia.

0.0.1-D-20220630.11****

TaskId

string

ID tugas Pembaruan OTA.

ota-e49929gv8acz5****

OsType

string

Tipe OS.

Windows

AppCenterImageName

string

Nama gambar aplikasi.

OfficeApps

ResourceStatus

string

Status resource.

AVAILABLE

OfficeSiteId

string

ID jaringan kantor.

cn-beijing+dir-172301****

AppPolicyId

string

ID kebijakan aplikasi.

pg-g3k5wa2ms2****

SkipUserAuthCheck

boolean

Menentukan apakah otorisasi pengguna dilewati.

Valid values:

  • true :

    Otorisasi tidak diperlukan.

  • false :

    Otorisasi diperlukan. (Default)

false

SessionType

string

Tipe sesi.

Valid values:

  • CONSOLE :

    Sesi konsol

  • NORMAL :

    Sesi RDP

NORMAL

Tags

array<object>

Tag resource.

object

Tag resource.

Key

string

Kunci tag.

department

Value

string

Nilai tag.

design

Scope

string

Tipe tag.

Valid values:

  • Custom :

    Tag kustom

  • System :

    Tag sistem

Custom

AuthMode

string

Model otorisasi.

Valid values:

  • App :

    Otorisasi aplikasi

  • AppInstanceGroup :

    Otorisasi AppInstanceGroup

  • Session :

    Otorisasi sesi

App

AccessType

string

Tipe akses.

Valid values:

  • INTERNET :

    internet

  • VPC :

    VPC

  • ANY :

    internet dan VPC

INTERNET

SupportUserGroupMixedAuth

boolean

UserGroupAuthMode

string

Mixed

Contoh

Respons sukses

JSONformat

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "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__",
    "AppInstanceTypeName": "test001",
    "AppInstanceGroupId": "aig-9ciijz60n4xsv****",
    "Amount": 1,
    "MinAmount": 1,
    "MaxAmount": 10,
    "ReserveAmountRatio": "20",
    "ReserveMinAmount": 1,
    "ReserveMaxAmount": 5,
    "ScalingStep": 10,
    "ScalingUsageThreshold": "85",
    "ScalingDownAfterIdleMinutes": 5,
    "ChargeType": "PrePaid",
    "ChargeResourceMode": "Node",
    "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",
    "AppCenterImageName": "OfficeApps",
    "ResourceStatus": "AVAILABLE",
    "OfficeSiteId": "cn-beijing+dir-172301****\n",
    "AppPolicyId": "pg-g3k5wa2ms2****",
    "SkipUserAuthCheck": false,
    "SessionType": "NORMAL",
    "Tags": [
      {
        "Key": "department",
        "Value": "design",
        "Scope": "Custom"
      }
    ],
    "AuthMode": "App",
    "AccessType": "INTERNET",
    "SupportUserGroupMixedAuth": false,
    "UserGroupAuthMode": "Mixed"
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.