DescribeInstanceRefreshes - Auto Scaling - Alibaba Cloud Documentation Center

Mengkueri tugas refresh instans dalam grup penskalaan, termasuk informasi dasar dan progres tugas.

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

ess:DescribeInstanceRefreshes

get

*ScalingGroup

acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah grup penskalaan.	cn-hangzhou
NextToken	string	No	Token paginasi. Atur parameter ini ke nilai NextToken yang dikembalikan dalam panggilan sebelumnya. Anda tidak perlu mengatur parameter ini untuk permintaan pertama.	caeba0bbb2be03f84eb48b699f0a****
MaxResults	integer	No	Jumlah maksimum entri per halaman dalam kueri paginasi. Nilai valid: 1 hingga 50. Nilai default: 10.	10
ScalingGroupId	string	No	ID grup penskalaan. Catatan Anda harus menentukan ScalingGroupId atau InstanceRefreshTaskIds. Jika Anda tidak menentukan salah satu parameter tersebut, error akan dikembalikan.	asg-bp1ffogfdauy0jw0****
InstanceRefreshTaskIds	array	No	ID tugas refresh instans yang ingin Anda kueri.
	string	No	ID tugas refresh instans yang ingin Anda kueri.	ir-adfa12312*****

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
NextToken	string	Token paginasi untuk kueri berikutnya. Jika NextToken kosong, tidak ada hasil lagi.	caeba0bbb2be03f84eb48b699f****
MaxResults	integer	Jumlah maksimum entri per halaman.	50
TotalCount	integer	Jumlah total tugas refresh instans.	100
InstanceRefreshTasks	array<object>	Daftar tugas refresh instans.
	array<object>	Tugas refresh instans.
ScalingGroupId	string	ID grup penskalaan.	asg-bp16pbfcr8j9*****
InstanceRefreshTaskId	string	ID tugas refresh instans.	ir-1adfa123****
RegionId	string	ID wilayah grup penskalaan.	cn-hangzhou
EndTime	string	Waktu selesai tugas refresh instans.	2024-08-22T02:09:00Z
StartTime	string	Waktu mulai tugas refresh instans.	2024-08-22T01:09:00Z
Status	string	Status saat ini dari tugas refresh instans. Nilai valid: Pending: Tugas refresh instans dibuat dan menunggu dijadwalkan. InProgress: Tugas refresh instans sedang berlangsung. Paused: Tugas refresh instans dijeda. CheckpointPause: Tugas refresh instans dijeda karena progres tugas mencapai checkpoint (`Checkpoint.Percentage`). Failed: Tugas refresh instans gagal. Successful: Tugas refresh instans berhasil. Cancelling: Tugas refresh instans sedang dibatalkan. Cancelled: Tugas refresh instans dibatalkan. RollbackInProgress: Tugas refresh instans sedang di-rollback. RollbackSuccessful: Tugas refresh instans di-rollback. RollbackFailed: Rollback tugas refresh instans gagal.	InProgress
Detail	string	Alasan kegagalan ketika tugas refresh instans gagal.	The task exceeded its maximum run time of one week. So the task failed.
MinHealthyPercentage	integer	Persentase minimum instans yang harus tetap aktif dalam layanan di grup penskalaan selama refresh instans.	80
MaxHealthyPercentage	integer	Persentase maksimum jumlah instans dalam grup penskalaan dapat melebihi kapasitas grup penskalaan selama refresh instans.	120
DesiredConfiguration	object	Konfigurasi yang diinginkan untuk refresh instans.
ImageId	string	ID file image yang digunakan untuk pembuatan otomatis instans.	m-uf6g5noisr****
ScalingConfigurationId	string	ID konfigurasi penskalaan.	asc-wz91ibkhfor****
LaunchTemplateId	string	ID template peluncuran tempat grup penskalaan memperoleh informasi konfigurasi peluncuran.	lt-2ze5x4mp*****
LaunchTemplateVersion	string	Versi template peluncuran. Nilai valid: Nomor versi template tetap. Default: selalu menggunakan versi default template. Latest: selalu menggunakan versi terbaru template.	Latest
LaunchTemplateOverrides	array<object>	Informasi tipe instans yang menggantikan template peluncuran.
	object	Informasi tipe instans yang menggantikan template peluncuran.
InstanceType	string	Tipe instans yang menggantikan tipe instans yang ditentukan dalam template peluncuran.	ecs.sn1ne.large
Containers	array<object>	Daftar kontainer yang disertakan dalam instans.
	array<object>	Daftar kontainer yang disertakan dalam instans.
Name	string	Nama kontainer kustom.	name
Image	string	Gambar kontainer.	registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:latest
Commands	array	Perintah startup kontainer.
	string	Perintah startup kontainer.	sleep
Args	array	Argumen untuk perintah startup kontainer.
	string	Argumen untuk perintah startup kontainer.	100
EnvironmentVars	array<object>	Informasi variabel lingkungan.
	object	Informasi variabel lingkungan.
Key	string	Nama variabel lingkungan.	PATH
Value	string	Nilai variabel lingkungan.	/usr/local/bin
FieldRefFieldPath	string	Catatan Parameter ini tidak tersedia untuk digunakan.	fieldPath
FinishedUpdateCapacity	integer	Kapasitas yang telah direfresh.	10
TotalNeedUpdateCapacity	integer	Total kapasitas yang perlu direfresh.	20
SkipMatching	boolean	Apakah instans yang sudah cocok dengan konfigurasi yang diinginkan dilewati. Catatan Sistem menentukan apakah instans cocok berdasarkan ID Konfigurasi penskalaan yang diinginkan, bukan dengan membandingkan item konfigurasi individual. Nilai valid: true: Dilewati. Ketika tugas refresh instans dimulai, sistem memeriksa konfigurasi setiap instans. Instans yang sudah dibuat dengan konfigurasi yang diinginkan tidak direfresh. false: Tidak dilewati. Setelah tugas refresh instans dimulai, semua instans dalam grup penskalaan direfresh.	true
CheckpointPauseTime	integer	Durasi jeda ketika tugas mencapai checkpoint. Unit: menit.	30
Checkpoints	array<object>	Checkpoint untuk tugas refresh. Checkpoint menentukan bahwa tugas secara otomatis dijeda selama CheckpointPauseTime menit ketika proporsi instans baru mencapai nilai yang ditentukan selama refresh instans.
	object	Checkpoint untuk tugas refresh. Checkpoint menentukan bahwa tugas secara otomatis dijeda selama CheckpointPauseTime menit ketika proporsi instans baru mencapai nilai yang ditentukan selama refresh instans.
Percentage	integer	Persentase instans baru relatif terhadap total instans di grup penskalaan. Tugas akan otomatis dijeda saat persentase ini tercapai.	60
Strategy	string	Strategi eksekusi tugas refresh instans. Nilai valid: Rolling: Tugas refresh instans membuat instans baru dan melepaskan instans lama untuk melakukan refresh. ReplaceSystemDisk: Tugas refresh instans mengganti cloud disk sistem pada instans yang ada.	Rolling

Contoh

Respons sukses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "NextToken": "caeba0bbb2be03f84eb48b699f****",
  "MaxResults": 50,
  "TotalCount": 100,
  "InstanceRefreshTasks": [
    {
      "ScalingGroupId": "asg-bp16pbfcr8j9*****",
      "InstanceRefreshTaskId": "ir-1adfa123****",
      "RegionId": "cn-hangzhou",
      "EndTime": "2024-08-22T02:09:00Z",
      "StartTime": "2024-08-22T01:09:00Z",
      "Status": "InProgress",
      "Detail": "The task exceeded its maximum run time of one week. So the task failed.",
      "MinHealthyPercentage": 80,
      "MaxHealthyPercentage": 120,
      "DesiredConfiguration": {
        "ImageId": "m-uf6g5noisr****",
        "ScalingConfigurationId": "asc-wz91ibkhfor****",
        "LaunchTemplateId": "lt-2ze5x4mp*****",
        "LaunchTemplateVersion": "Latest",
        "LaunchTemplateOverrides": [
          {
            "InstanceType": "ecs.sn1ne.large"
          }
        ],
        "Containers": [
          {
            "Name": "name",
            "Image": "registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:latest",
            "Commands": [
              "sleep"
            ],
            "Args": [
              "100"
            ],
            "EnvironmentVars": [
              {
                "Key": "PATH",
                "Value": "/usr/local/bin",
                "FieldRefFieldPath": "fieldPath"
              }
            ]
          }
        ]
      },
      "FinishedUpdateCapacity": 10,
      "TotalNeedUpdateCapacity": 20,
      "SkipMatching": true,
      "CheckpointPauseTime": 30,
      "Checkpoints": [
        {
          "Percentage": 60
        }
      ],
      "Strategy": "Rolling"
    }
  ]
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.