ListAppInstanceGroup - App Streaming - Alibaba Cloud Documentation Center

Mengambil detail beberapa delivery group. Jika Anda tidak menentukan delivery group tertentu, operasi ini akan mengembalikan detail semua grup yang sesuai dengan kriteria yang ditetapkan.

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

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
PageSize	integer	No	Jumlah entri yang dikembalikan per halaman. Nilai maksimum adalah `100`.	10
PageNumber	integer	No	Nomor halaman.	1
Status	array	No	Status grup instans aplikasi.
	string	No	Status grup instans aplikasi. Valid values: PUBLISHED : Diterbitkan FAILED : Penerbitan gagal MAINTAIN_FAILED : Pembaruan gagal EXPIRED : Kedaluwarsa MAINTAINING : Memperbarui CEASED : Ditangguhkan karena pembayaran tertunda. EXPIRED_RECYCLING : Kedaluwarsa dan sedang didaur ulang. DEPLOYING : Menerbitkan	"Status.1":"PUBLISHED","Status.2":"FAILED"
AppInstanceGroupId	string	No	ID grup instans aplikasi.	aig-9ciijz60n4xsv****
ProductType	string	Yes	Tipe produk. Valid values: CloudApp : Wuying Cloud Application	CloudApp
AppInstanceGroupName	string	No	Nama grup instans aplikasi. Parameter ini mendukung pencarian fuzzy. Misalnya, jika Anda mengatur parameter ini ke `OfficeApps`, grup instans aplikasi yang namanya mengandung `OfficeApps`, seperti `MyOfficeApps` dan `OfficeApps A`, akan dikembalikan.	办公应用
AppCenterImageId	string	No	ID gambar aplikasi. Anda dapat memperoleh ID gambar di halaman Image Management di konsol Wuying Cloud Application.	img-8z4nztpaqvay4****
RegionId `deprecated`	string	No	ID wilayah.	cn-hangzhou
BizRegionId	string	No	ID wilayah grup instans aplikasi. Untuk informasi selengkapnya tentang wilayah yang didukung, lihat Limits. Valid values: cn-shanghai : China (Shanghai) cn-hangzhou : China (Hangzhou)	cn-hangzhou
NodeInstanceType	string	No	Tipe instans. Anda dapat memanggil operasi ListNodeInstanceType untuk memperoleh tipe instans.	appstreaming.vgpu.4c8g.2g
OfficeSiteId	string	No	ID jaringan kantor.	cn-hongkong+dir-643067****
Tag	array<object>	No	Tag.
	object	No	Tag.
Key	string	No	Kunci tag.	department
Value	string	No	Nilai tag.	design
UserGroupIds	array	No
	string	No
ExcludedUserGroupIds	array	No
	string	No

Elemen respons

Element	Type	Description	Example
	object	Data yang dikembalikan.
RequestId	string	ID permintaan.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
TotalCount	integer	Total jumlah entri.	15
PageSize	integer	Jumlah entri per halaman.	10
PageNumber	integer	Nomor halaman.	1
AppInstanceGroupModels	array<object>	Detail grup instans aplikasi.
	array<object>	Detail grup instans aplikasi.
Apps	array<object>	Aplikasi dalam grup instans 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	Ikon aplikasi.	https://app-center-icon-****.png
AppCenterImageId	string	ID gambar aplikasi.	img-8z4nztpaqvay4****
RegionId	string	ID wilayah tempat grup instans aplikasi berada. Untuk informasi selengkapnya tentang wilayah yang didukung, lihat Limits.	cn-hangzhou
ProductType	string	Jenis produk. Valid values: CloudApp : Wuying Cloud Application	CloudApp
AppInstanceType	string	Tipe instans dari kelompok instans aplikasi.	__dynamic__
AppInstanceGroupId	string	ID grup instans aplikasi.	aig-9ciijz60n4xsv****
Amount	integer	Jumlah resource langganan yang disediakan.	1
MinAmount	integer	Jumlah minimum instans.	1
MaxAmount	integer	Jumlah maksimum instans.	10
ReserveAmountRatio	string	Persentase sesi idle yang disimpan sebagai cadangan. Nilai valid: 0 hingga 99.	20
ReserveMinAmount	integer	Jumlah minimum sesi idle yang disimpan sebagai cadangan.	1
ReserveMaxAmount	integer	Jumlah maksimum sesi idle yang disimpan sebagai cadangan.	5
ScalingStep	integer	Jumlah sesi yang dibuat dalam setiap event skala keluar.	10
ScalingUsageThreshold	string	Ambang batas penggunaan sesi yang memicu auto scale-out, dalam persentase. Auto scale-out dipicu ketika penggunaan sesi melebihi ambang batas ini. Penggunaan sesi dihitung menggunakan rumus berikut: `(Jumlah sesi aktif / Total jumlah sesi) × 100%`. Nilai valid: 0 hingga 99.	85
ScalingDownAfterIdleMinutes	integer	Waktu dalam menit yang boleh dilewati oleh resource dalam kondisi idle (tanpa koneksi sesi) sebelum scale-in dipicu. Nilai minimum adalah 0.	5
ChargeType	string	Metode penagihan. Valid values: PostPaid : pay-as-you-go PrePaid : subscription	PrePaid
GmtCreate	string	Waktu saat grup instans aplikasi dibuat.	2022-04-26T15:06:16.000+00:00
Status	string	Status grup instans aplikasi. Valid values: PUBLISHED : Diterbitkan. FAILED : Penerbitan gagal. MAINTAIN_FAILED : Pembaruan gagal. EXPIRED : Kedaluwarsa. MAINTAINING : Memperbarui. CEASED : Ditangguhkan karena pembayaran tertunda. EXPIRED_RECYCLING : Kedaluwarsa dan sedang didaur ulang. DEPLOYING : Menerbitkan.	PUBLISHED
NodePool	array<object>	Kelompok node dalam grup instans aplikasi.
	array<object>	Detail kelompok node.
NodePoolId	string	ID kelompok node.	rg-g6922kced36hx****
NodeInstanceType	string	Tipe instans node dalam pool.	appstreaming.vgpu.4c8g.2g
NodeAmount	integer	Total jumlah resource langganan dalam kelompok node.	1
NodeUsed	integer	Jumlah resource langganan yang sedang digunakan dalam kelompok node.	1
NodeCapacity	integer	Jumlah sesi konkuren yang dapat dihosting oleh satu resource. Nilai tinggi dapat menurunkan pengalaman pengguna, dan nilai valid bervariasi berdasarkan spesifikasi resource.	2
ScalingNodeAmount	integer	Total jumlah resource pay-as-you-go.	8
ScalingNodeUsed	integer	Jumlah resource pay-as-you-go yang sedang digunakan.	4
StrategyType	string	Jenis kebijakan penskalaan. Catatan Kebijakan penskalaan berbasis penggunaan (`NODE_SCALING_BY_USAGE`) hanya berlaku untuk resource langganan. Kebijakan penskalaan terjadwal (`NODE_SCALING_BY_SCHEDULE`) hanya berlaku untuk resource pay-as-you-go. Valid values: NODE_FIXED : Tidak menggunakan resource elastis. NODE_SCALING_BY_SCHEDULE : Penjadwalan penskalaan NODE_SCALING_BY_USAGE : Penskalaan berbasis penggunaan	NODE_FIXED
Amount	integer	Jumlah resource yang dibeli saat grup instans aplikasi dibuat.	2
MaxScalingAmount	integer	Jumlah maksimum resource yang dapat dibuat dalam satu event skala keluar.	8
MaxIdleAppInstanceAmount	integer	Jumlah maksimum sesi idle yang dipertahankan. Jika ditentukan, skala keluar hanya dipicu ketika penggunaan sesi melebihi `ScalingUsageThreshold` dan jumlah sesi idle kurang dari `MaxIdleAppInstanceAmount`. Parameter ini membantu Anda mengontrol perilaku penskalaan dan mengurangi biaya.	3
ScalingStep	integer	Jumlah resource yang dibuat dalam setiap event skala keluar. Nilai valid: 1 hingga 10.	2
ScalingUsageThreshold	string	Persentase penggunaan sesi yang memicu skala keluar otomatis. Skala keluar terjadi jika penggunaan, yang dihitung menggunakan rumus `Penggunaan sesi = (Jumlah sesi saat ini / (Total jumlah resource × Jumlah sesi konkuren per resource)) × 100%`, melebihi nilai ini.	85
ScalingDownAfterIdleMinutes	integer	Waktu dalam menit yang boleh dilewati oleh resource dalam kondisi idle sebelum skala-masuk otomatis dipicu. Nilai default: 5.	5
RecurrenceSchedules	array<object>	Jadwal untuk kebijakan penskalaan.
	array<object>	Jadwal untuk kebijakan penskalaan.
RecurrenceType	string	Jenis pengulangan untuk tugas terjadwal. Anda harus menentukan `RecurrenceType` dan `RecurrenceValues`. Valid values: weekly : Tugas terjadwal diulang pada hari-hari tertentu dalam seminggu.	Weekly
RecurrenceValues	array	Nilai untuk jadwal pengulangan.
	integer	Nilai untuk jadwal pengulangan. Valid values: 1 : Senin 2 : Selasa 3 : Rabu 4 : Kamis 5 : Jumat 6 : Sabtu 7 : Minggu	1
TimerPeriods	array<object>	Periode waktu saat kebijakan berlaku.
	object	Periode waktu.
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 saat kebijakan menjadi tidak efektif. Tanggal dalam format yyyy-MM-dd.	2022-09-08
StrategyEnableDate	string	Tanggal saat kebijakan mulai berlaku. Tanggal 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 unik yang dipetakan satu-ke-satu dengan ID grup instans aplikasi.	spec-8o18t8uc31qib0****
SessionTimeout	string	Waktu dalam menit untuk menjaga sesi tetap aktif setelah pengguna terputus. Setelah waktu ini berlalu, sesi akan dihentikan. Untuk menjaga sesi tetap aktif tanpa batas, atur nilai ini ke `-1`. Nilai valid: -1 atau 3 hingga 300. Default: `15`.	15
AppInstanceGroupName	string	Nama grup instans aplikasi.	办公应用
ExpiredTime	string	Waktu saat grup instans aplikasi kedaluwarsa.	2022-04-27T16:00:00.000+00:00
OtaInfo	object	Detail 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	Sistem operasi. Valid values: Windows : Windows	Windows
ResourceStatus	string	Status resource. Valid values: AVAILABLE : Tersedia RELEASED : Dilepas EXPIRED_IN_7_DAYS : Kedaluwarsa dalam 7 hari UNAVAILABLE : Tidak tersedia UPGRADING : Memperbarui CREATING : Membuat	AVAILABLE
AppPolicyId	string	ID kebijakan.	pg-g3k5wa2ms2****
ChargeResourceMode	string	Model penagihan resource. Valid values: AppInstance : Ditagih per sesi Node : Ditagih per resource	Node
SkipUserAuthCheck	boolean	Menunjukkan apakah otorisasi pengguna dilewati. Valid values: true : Otorisasi pengguna dilewati. false : Otorisasi pengguna diverifikasi. Ini adalah nilai default.	false
OfficeSiteId	string	ID jaringan kantor.	cn-beijing+dir-172301****
AppPolicyVersion	string	Versi kebijakan. Valid values: CENTER : Kebijakan terpadu (baru) DEFAULT : Kebijakan default (lama)	CENTER
AppPolicyImageCheck	boolean	Menunjukkan apakah gambar saat ini mendukung kebijakan terpadu. Valid values: true : Didukung false : Tidak didukung	false
ResourceTags	array<object>	Tag yang dilampirkan pada resource.
	object	Tag sumber daya.
Key	string	Kunci tag.	department
Value	string	Nilai tag.	design
Scope	string	Jenis tag. Valid values: Custom : Tag kustom System : Tag sistem	Custom
Tags	array<object>	Tag yang dilampirkan pada resource.
	object	Tag resource.
Key	string	Kunci tag.	department
Value	string	Nilai tag.	design
Scope	string	Jenis tag. Valid values: Custom : Tag kustom System : Tag sistem	Custom
AuthMode	string	Model otorisasi. Valid values: App : Otorisasi berbasis aplikasi AppInstanceGroup : Otorisasi berbasis grup instans aplikasi Session : Otorisasi berbasis sesi	App
AccessType	string	Jenis akses. Valid values: INTERNET : Internet VPC : Virtual private cloud (VPC) ANY : Internet dan virtual private cloud (VPC)	INTERNET
SupportUserGroupMixedAuth	boolean
UserGroupAuthMode	string		Mixed

Contoh

Respons sukses

JSONformat

{
  "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"
    }
  ]
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.