DescribeAutoProvisioningGroups - Elastic Compute Service

Mengkueri satu atau beberapa kelompok penyediaan otomatis.

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

ecs:DescribeAutoProvisioningGroups

get

*Semua sumber daya.

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah tempat kelompok penyediaan otomatis berada.	cn-hangzhou
PageNumber	integer	No	Nomor halaman daftar yang dikembalikan dalam kueri halaman. Nilai minimum: 1. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman dalam kueri halaman. Nilai maksimum: 100. Nilai default: 10.	2
AutoProvisioningGroupName	string	No	Nama kelompok penyediaan otomatis.	testAutoProvisioningGroupName
ResourceGroupId	string	No	ID kelompok sumber daya tempat grup penyediaan otomatis berada.	rg-bp67acfmxazb4p****
AutoProvisioningGroupId	array	No	ID kelompok penyediaan otomatis. Anda dapat menentukan hingga 20 ID kelompok penyediaan otomatis.	apg-sn54avj8htgvtyh8****
	string	No	ID kelompok penyediaan otomatis.	apg-sn54avj8htgvtyh8****
AutoProvisioningGroupStatus	array	No	Daftar status kelompok penyediaan otomatis.	active
	string	No	Status kelompok penyediaan otomatis. Nilai valid: submitted: Kelompok penyediaan otomatis telah dibuat tetapi belum mulai Berjalan tugas penjadwalan. active: Kelompok penyediaan otomatis telah mulai Berjalan tugas penjadwalan. deleted: Kelompok penyediaan otomatis telah dihapus. delete-running: Kelompok penyediaan otomatis sedang dihapus. modifying: Kelompok penyediaan otomatis sedang dimodifikasi.	active
AutoProvisioningGroupTypes	array	No	Tipe kelompok penyediaan otomatis. Nilai valid: request, maintain, dan candidate.
	string	No	Tipe kelompok penyediaan otomatis. Nilai valid: request, maintain, dan candidate.	request
Tag	array<object>	No	Tag yang terpasang pada kelompok penyediaan otomatis.
	object	No	Tag yang terpasang pada kelompok penyediaan otomatis.
Key	string	No	Kunci tag kelompok penyediaan otomatis. Nilai valid N: 1 hingga 20. Kunci tag tidak boleh berupa string kosong. Panjang kunci tag dapat mencapai 128 karakter dan tidak boleh diawali dengan aliyun atau acs:. Kunci tag tidak boleh mengandung http:// atau https://.	TestKey
Value	string	No	Nilai tag kelompok penyediaan otomatis. Nilai valid N: 1 hingga 20. Nilai tag dapat berupa string kosong. Panjang nilai tag dapat mencapai 128 karakter dan tidak boleh mengandung http:// atau https://.	TestValue

Elemen respons

Element	Type	Description	Example
	object
PageSize	integer	Jumlah entri per halaman.	10
RequestId	string	ID permintaan.	745CEC9F-0DD7-4451-9FE7-8B752F39****
PageNumber	integer	Nomor halaman.	1
TotalCount	integer	Jumlah total kelompok penyediaan otomatis yang dikueri.	10
AutoProvisioningGroups	object
AutoProvisioningGroup	array<object>	Detail kelompok penyediaan otomatis.
	array<object>	Detail kelompok penyediaan otomatis.
CreationTime	string	Waktu pembuatan. Waktu ditampilkan dalam format ISO 8601 UTC.	2019-04-01T15:10:20Z
AutoProvisioningGroupName	string	Nama kelompok penyediaan otomatis.	EcsDocTest
Status	string	Status kelompok penyediaan otomatis. Nilai valid: submitted: Kelompok penyediaan otomatis telah dibuat tetapi belum mulai Berjalan. active: Kelompok penyediaan otomatis telah mulai Berjalan. deleted: Kelompok penyediaan otomatis telah dihapus. delete-running: Kelompok penyediaan otomatis sedang dihapus. modifying: Kelompok penyediaan otomatis sedang dimodifikasi.	submitted
TerminateInstances	boolean	Apakah akan merilis instans dalam kelompok penyediaan otomatis saat kelompok dihapus. Nilai valid: true: Merilis instans dalam kelompok. false: Mempertahankan instans dalam kelompok.	false
MaxSpotPrice	number	Harga maksimum spot instans. Catatan Jika MaxSpotPrice dan LaunchTemplateConfig.N.MaxPrice keduanya ditentukan, nilai yang lebih rendah akan diutamakan. LaunchTemplateConfig.N.MaxPrice ditetapkan saat Anda membuat kelompok penyediaan otomatis dan tidak dapat dimodifikasi.	2
State	string	Status penjadwalan keseluruhan kelompok penyediaan otomatis. Nilai valid: fulfilled: Tugas penjadwalan telah selesai. pending-fulfillment: Instans sedang dibuat. pending-termination: Instans sedang dihapus. error: Terjadi error selama penjadwalan dan kluster instans gagal dikirimkan.	fulfilled
LaunchTemplateId	string	ID template peluncuran instans terkait.	lt-bp1fgzds4bdogu03****
ValidFrom	string	Waktu mulai kelompok penyediaan otomatis. Nilai parameter ini dan nilai ValidUntil menentukan periode efektif kelompok penyediaan otomatis.	2019-04-01T15:10:20Z
LaunchTemplateVersion	string	Versi template peluncuran instans terkait.	1
TerminateInstancesWithExpiration	boolean	Apakah akan merilis instans dalam kelompok penyediaan otomatis saat kelompok kedaluwarsa. Nilai valid: true: Instans dalam kelompok dirilis. false: Instans dihapus dari kelompok.	true
RegionId	string	ID wilayah.	cn-hangzhou
ValidUntil	string	Waktu kedaluwarsa kelompok penyediaan otomatis. Parameter ini dan ValidFrom menentukan periode validitas.	2019-06-01T15:10:20Z
AutoProvisioningGroupType	string	Tipe pengatur waktu. Nilai valid: request: satu kali. Kelompok penyediaan otomatis mengirimkan kluster instans hanya saat startup dan tidak mencoba lagi setelah kegagalan penjadwalan. maintain: penyediaan berkelanjutan. Kelompok penyediaan otomatis mencoba mengirimkan kluster instans saat startup dan memantau kapasitas real-pengatur waktu. Jika kapasitas target tidak terpenuhi, kelompok akan terus membuat instans ECS.	maintain
AutoProvisioningGroupId	string	ID kelompok penyediaan otomatis.	apg-sn54avj8htgvtyh8****
ExcessCapacityTerminationPolicy	string	Apakah akan merilis instans yang diskalakan masuk saat kapasitas real-pengatur waktu kelompok penyediaan otomatis melebihi kapasitas target dan event skala masuk dipicu. Nilai valid: termination: Merilis instans yang diskalakan masuk. no-termination: Hanya menghapus instans yang diskalakan masuk dari kelompok penyediaan otomatis.	termination
ResourceGroupId	string	ID kelompok sumber daya tempat grup penyediaan otomatis berada.	rg-bp67acfmxazb4p****
LaunchTemplateConfigs	object
LaunchTemplateConfig	array<object>	Detail template peluncuran yang diperluas.
	object
MaxPrice	number	Harga maksimum tipe instans yang ditentukan dalam template peluncuran yang diperluas.	3
Priority	number	Prioritas tipe instans yang ditentukan dalam template peluncuran yang diperluas. Nilai 0 menunjukkan prioritas tertinggi.	1
VSwitchId	string	ID vSwitch yang ditentukan dalam template peluncuran yang diperluas.	vsw-sn5bsitu4lfzgc5o7****
WeightedCapacity	number	Bobot tipe instans yang ditentukan dalam template peluncuran yang diperluas.	2
InstanceType	string	Tipe instans yang ditentukan dalam template peluncuran yang diperluas.	ecs.g5.large
SpotOptions	object	Kebijakan yang terkait dengan spot instans.
InstancePoolsToUseCount	integer	Jumlah tipe instans dengan harga terendah yang digunakan kelompok penyediaan otomatis untuk membuat instans. Catatan Parameter ini ditetapkan saat Anda membuat kelompok penyediaan otomatis dan tidak dapat dimodifikasi.	2
AllocationStrategy	string	Kebijakan untuk membuat spot instans. Nilai valid: lowest-price: kebijakan optimasi biaya. Tipe spot instans dengan harga terendah. diversified: kebijakan distribusi zona seimbang. Spot instans di zona yang ditentukan dalam template peluncuran yang diperluas dan mendistribusikannya secara merata di seluruh zona.	diversified
InstanceInterruptionBehavior	string	Aksi yang dilakukan setelah spot instans berlebih dihentikan. Nilai valid: stop: Menjaga instans dalam status berhenti. terminate: Menghentikan tugas.	stop
PayAsYouGoOptions	object	Kebijakan untuk instans pay-as-you-go.
AllocationStrategy	string	Kebijakan untuk membuat instans pay-as-you-go. Nilai valid: lowest-price: kebijakan optimasi biaya. Tipe instans dengan harga terendah dipilih. prioritized: kebijakan berbasis prioritas. Instans dibuat berdasarkan prioritas yang ditentukan oleh LaunchTemplateConfig.N.Priority. Catatan LaunchTemplateConfig.N.Priority ditentukan saat Anda membuat kelompok penyediaan otomatis dan tidak dapat dimodifikasi.	prioritized
TargetCapacitySpecification	object	Pengaturan kapasitas target kelompok penyediaan otomatis.
SpotTargetCapacity	number	Kapasitas target spot instans.	20
PayAsYouGoTargetCapacity	number	Kapasitas target instans bayar sesuai pemakaian.	30
DefaultTargetCapacityType	string	Metode penagihan selisih kapasitas saat jumlah PayAsYouGoTargetCapacity dan SpotTargetCapacity kurang dari TotalTargetCapacity. Nilai valid: PayAsYouGo: instans pay-as-you-go. Spot: spot instans.	Spot
TotalTargetCapacity	number	Kapasitas total target kelompok penyediaan otomatis, yang terdiri dari tiga bagian berikut: PayAsYouGoTargetCapacity SpotTargetCapacity Selisih antara TotalTargetCapacity dan jumlah PayAsYouGoTargetCapacity serta SpotTargetCapacity	60
Tags	object
Tag	array<object>	Tag yang terpasang pada kelompok penyediaan otomatis.
	object	Tag yang terpasang pada kelompok penyediaan otomatis.
TagKey	string	Kunci tag kelompok penyediaan otomatis. Nilai valid N: 1 hingga 20. Kunci tag tidak boleh berupa string kosong. Panjang kunci tag dapat mencapai 128 karakter dan tidak boleh diawali dengan aliyun atau acs:. Kunci tag tidak boleh mengandung http:// atau https://.	TestKey
TagValue	string	Nilai tag kelompok penyediaan otomatis. Nilai valid N: 1 hingga 20. Nilai tag dapat berupa string kosong. Panjang nilai tag dapat mencapai 128 karakter dan tidak boleh mengandung http:// atau https://.	TestValue
CandidateOptions	object	Konfigurasi yang terkait dengan tipe kandidat.
TimeoutMinutes	integer	Periode waktu tunggu saat kelompok penyediaan otomatis mencoba melakukan skala keluar ke kapasitas target. Unit: menit.	60
CapacitySpecification	object	Distribusi kapasitas saat ini dari kelompok penyediaan otomatis.
PayAsYouGoCapacity	number	Kapasitas instans pay-as-you-go saat ini dalam kelompok penyediaan otomatis.	2
PrePaidCapacity	number	Kapasitas instans langganan saat ini dalam kelompok penyediaan otomatis.	0
SpotCapacity	number	Kapasitas spot instans saat ini dalam kelompok penyediaan otomatis.	3
TotalCapacity	number	Kapasitas total instans saat ini dalam kelompok penyediaan otomatis.	5
SuspendedProcesses	object
SuspendedProcess	array	Proses yang ditangguhkan dari kelompok penyediaan otomatis. Nilai valid: ScaleIn: proses skala masuk. ScaleOut: proses skala keluar.
	string	Proses yang ditangguhkan dari kelompok penyediaan otomatis. Nilai valid: ScaleIn: proses skala masuk. ScaleOut: proses skala keluar.	ScaleOut

Contoh

Respons sukses

JSONformat

{
  "PageSize": 10,
  "RequestId": "745CEC9F-0DD7-4451-9FE7-8B752F39****",
  "PageNumber": 1,
  "TotalCount": 10,
  "AutoProvisioningGroups": {
    "AutoProvisioningGroup": [
      {
        "CreationTime": "2019-04-01T15:10:20Z",
        "AutoProvisioningGroupName": "EcsDocTest",
        "Status": "submitted",
        "TerminateInstances": false,
        "MaxSpotPrice": 2,
        "State": "fulfilled",
        "LaunchTemplateId": "lt-bp1fgzds4bdogu03****",
        "ValidFrom": "2019-04-01T15:10:20Z",
        "LaunchTemplateVersion": "1",
        "TerminateInstancesWithExpiration": true,
        "RegionId": "cn-hangzhou",
        "ValidUntil": "2019-06-01T15:10:20Z",
        "AutoProvisioningGroupType": "maintain",
        "AutoProvisioningGroupId": "apg-sn54avj8htgvtyh8****",
        "ExcessCapacityTerminationPolicy": "termination",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "LaunchTemplateConfigs": {
          "LaunchTemplateConfig": [
            {
              "MaxPrice": 3,
              "Priority": 1,
              "VSwitchId": "vsw-sn5bsitu4lfzgc5o7****",
              "WeightedCapacity": 2,
              "InstanceType": "ecs.g5.large"
            }
          ]
        },
        "SpotOptions": {
          "InstancePoolsToUseCount": 2,
          "AllocationStrategy": "diversified",
          "InstanceInterruptionBehavior": "stop"
        },
        "PayAsYouGoOptions": {
          "AllocationStrategy": "prioritized"
        },
        "TargetCapacitySpecification": {
          "SpotTargetCapacity": 20,
          "PayAsYouGoTargetCapacity": 30,
          "DefaultTargetCapacityType": "Spot",
          "TotalTargetCapacity": 60
        },
        "Tags": {
          "Tag": [
            {
              "TagKey": "TestKey",
              "TagValue": "TestValue"
            }
          ]
        },
        "CandidateOptions": {
          "TimeoutMinutes": 60
        },
        "CapacitySpecification": {
          "PayAsYouGoCapacity": 2,
          "PrePaidCapacity": 0,
          "SpotCapacity": 3,
          "TotalCapacity": 5
        },
        "SuspendedProcesses": {
          "SuspendedProcess": [
            "ScaleOut"
          ]
        }
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	MissingParamter.RegionId	The regionId should not be null.	Parameter RegionId tidak boleh kosong.
400	InvalidName.Malformed	The specified parameter "AutoProvisioningGroupName" is not valid.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.