DescribeInstanceRefreshes - Auto Scaling - Alibaba Cloud Documentation Center

Mengkueri tugas penyegaran instans dari 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 pagination. Atur parameter ini ke nilai NextToken yang dikembalikan pada panggilan sebelumnya. Anda tidak perlu mengatur parameter ini untuk permintaan pertama.	caeba0bbb2be03f84eb48b699f0a****
MaxResults	integer	No	Jumlah maksimum entri per halaman dalam kueri pagination. Nilai valid: 1 hingga 50. Nilai default: 10.	10
ScalingGroupId	string	Yes	ID grup penskalaan.	asg-bp1ffogfdauy0jw0****
InstanceRefreshTaskId	array	No	ID tugas penyegaran instans yang ingin Anda kueri.
	string	No	ID tugas penyegaran instans yang ingin Anda kueri. Nilai valid N: 1 hingga 20.	ir-adfa12312*****

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
NextToken	string	Token pagination untuk kueri berikutnya. Jika NextToken kosong, tidak ada hasil lagi.	caeba0bbb2be03f84eb48b699f****
MaxResults	integer	Jumlah maksimum entri per halaman.	50
TotalCount	integer	Jumlah total tugas penyegaran instans.	100
InstanceRefreshTasks	object
InstanceRefreshTask	array<object>	Daftar tugas penyegaran instans.
	array<object>	Tugas penyegaran instans.
InstanceRefreshTaskId	string	ID tugas penyegaran instans.	ir-1adfa123****
ScalingGroupId	string	ID grup penskalaan.	asg-bp16pbfcr8j9*****
RegionId	string	ID wilayah grup penskalaan.	cn-hangzhou
EndTime	string	Pengatur waktu berakhir tugas penyegaran instans.	2024-08-22T02:09:00Z
StartTime	string	Pengatur waktu mulai tugas penyegaran instans.	2024-08-22T01:09:00Z
Status	string	Status saat ini tugas penyegaran instans. Nilai valid: Pending: Tugas penyegaran instans telah dibuat dan menunggu penjadwalan. InProgress: Tugas penyegaran instans sedang berlangsung. Paused: Tugas penyegaran instans dijeda. CheckpointPause: Tugas penyegaran instans dijeda karena progres tugas telah mencapai checkpoint (`Checkpoint.Percentage`). Failed: Tugas penyegaran instans gagal. Successful: Tugas penyegaran instans berhasil. Cancelling: Tugas penyegaran instans sedang dibatalkan. Cancelled: Tugas penyegaran instans dibatalkan. RollbackInProgress: Tugas penyegaran instans sedang di-rollback. RollbackSuccessful: Tugas penyegaran instans telah di-rollback. RollbackFailed: Rollback tugas penyegaran instans gagal.	InProgress
Detail	string	Alasan kegagalan spesifik ketika tugas penyegaran instans gagal.	Tugas melebihi pengatur waktu berjalan maksimum selama satu minggu. Jadi, tugas gagal.
MinHealthyPercentage	integer	Persentase minimum instans yang harus tetap dalam layanan di grup penskalaan selama penyegaran instans.	80
MaxHealthyPercentage	integer	Persentase maksimum jumlah instans di grup penskalaan yang dapat melebihi kapasitas grup penskalaan selama penyegaran instans.	120
DesiredConfiguration	object	Konfigurasi yang diinginkan untuk penyegaran 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 yang digunakan oleh grup penskalaan untuk mendapatkan 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	object
LaunchTemplateOverride	array<object>	Informasi tipe instans yang memperluas template peluncuran.
	object	Informasi tipe instans yang memperluas template peluncuran.
InstanceType	string	Tipe instans yang ditentukan, yang menggantikan tipe instans di template peluncuran.	ecs.g7.2xlarge
Containers	object
Container	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	object
Command	array	Perintah startup kontainer.
	string	Perintah startup kontainer.	sleep
EnvironmentVars	object
EnvironmentVar	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
Args	object
Arg	array	Argumen untuk perintah startup kontainer.
	string	Argumen untuk perintah startup kontainer.	100
FinishedUpdateCapacity	integer	Kapasitas yang telah disegarkan.	10
TotalNeedUpdateCapacity	integer	Total kapasitas yang perlu disegarkan.	20
SkipMatching	boolean	Apakah akan melewatkan instans yang cocok dengan konfigurasi yang diinginkan. Catatan Sistem menentukan apakah instans cocok berdasarkan ID konfigurasi penskalaan yang diinginkan, bukan dengan membandingkan item konfigurasi spesifik. Nilai valid: true: Dilewatkan. Ketika tugas penyegaran instans dimulai, sistem memeriksa konfigurasi setiap instans. Instans yang sudah dibuat dengan konfigurasi yang diinginkan tidak akan disegarkan. false: Tidak dilewatkan. Setelah tugas penyegaran instans dimulai, semua instans di grup penskalaan akan disegarkan.	true
CheckpointPauseTime	integer	Durasi jeda tugas ketika checkpoint tercapai. Unit: menit.	30
Checkpoints	object
Checkpoint	array<object>	Checkpoint tugas penyegaran. Menentukan bahwa tugas akan dijeda secara otomatis selama CheckpointPauseTime menit ketika proporsi instans baru mencapai nilai yang ditentukan selama penyegaran instans.
	object	Checkpoint tugas penyegaran. Menentukan bahwa tugas akan dijeda secara otomatis selama CheckpointPauseTime menit ketika proporsi instans baru mencapai nilai yang ditentukan selama penyegaran instans.
Percentage	integer	Persentase instans baru relatif terhadap total instans di grup penskalaan. Tugas akan dijeda secara otomatis ketika persentase ini tercapai.	60
Strategy	string

Contoh

Respons sukses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "NextToken": "caeba0bbb2be03f84eb48b699f****",
  "MaxResults": 50,
  "TotalCount": 100,
  "InstanceRefreshTasks": {
    "InstanceRefreshTask": [
      {
        "InstanceRefreshTaskId": "ir-1adfa123****",
        "ScalingGroupId": "asg-bp16pbfcr8j9*****",
        "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": {
            "LaunchTemplateOverride": [
              {
                "InstanceType": "ecs.g7.2xlarge"
              }
            ]
          },
          "Containers": {
            "Container": [
              {
                "Name": "name",
                "Image": "registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:latest",
                "Commands": {
                  "Command": [
                    "sleep"
                  ]
                },
                "EnvironmentVars": {
                  "EnvironmentVar": [
                    {
                      "Key": "PATH",
                      "Value": "/usr/local/bin",
                      "FieldRefFieldPath": "fieldPath"
                    }
                  ]
                },
                "Args": {
                  "Arg": [
                    "100"
                  ]
                }
              }
            ]
          }
        },
        "FinishedUpdateCapacity": 10,
        "TotalNeedUpdateCapacity": 20,
        "SkipMatching": true,
        "CheckpointPauseTime": 30,
        "Checkpoints": {
          "Checkpoint": [
            {
              "Percentage": 60
            }
          ]
        },
        "Strategy": ""
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.