DescribeScalingRules - Auto Scaling - Alibaba Cloud Documentation Center

Memanggil DescribeScalingRules untuk mengkueri aturan penskalaan dan detailnya dengan menentukan parameter seperti ID aturan penskalaan, nama aturan penskalaan, dan pengenal unik aturan penskalaan. Misalnya, Anda dapat mengkueri mode penyesuaian, pengatur waktu pemanasan instans, dan informasi tugas alarm yang terkait dengan aturan penskalaan.

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

get

*ScalingGroup

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah grup penskalaan tempat aturan penskalaan berada.	cn-qingdao
PageNumber	integer	No	Nomor halaman daftar aturan penskalaan. Nilai minimum: 1. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman untuk kueri terpaginasi. Nilai maksimum: 50. Nilai default: 10.	50
ScalingGroupId	string	No	ID grup penskalaan.	asg-bp1ffogfdauy0jw0****
ScalingRuleType	string	No	Tipe aturan penskalaan. Nilai valid: SimpleScalingRule: aturan skalabilitas sederhana. Menyesuaikan jumlah instans ECS berdasarkan metode penyesuaian (AdjustmentType) dan nilai penyesuaian (AdjustmentValue). TargetTrackingScalingRule: aturan penskalaan pelacakan target. Menghitung secara dinamis jumlah instans ECS yang akan diskalakan berdasarkan data deret waktu yang telah ditentukan sebelumnya (MetricName) dan berupaya mempertahankan nilai data deret waktu mendekati nilai target (TargetValue). StepScalingRule: aturan penskalaan bertahap. Menyediakan penskalaan berbasis langkah berdasarkan ambang batas dan nilai data deret waktu. PredictiveScalingRule: aturan penskalaan memprediksi. Menggunakan pembelajaran mesin untuk menganalisis data pemantauan historis grup penskalaan guna memprediksi nilai data deret waktu di masa mendatang dan mendukung pembuatan otomatis tugas terjadwal untuk menetapkan batas grup penskalaan.	SimpleScalingRule
ShowAlarmRules	boolean	No	Apakah akan mengembalikan tugas alarm CloudMonitor yang terkait dengan aturan penskalaan. Nilai valid: true: Mengembalikan tugas alarm CloudMonitor yang terkait dengan aturan penskalaan. false: Tidak mengembalikan tugas alarm CloudMonitor yang terkait dengan aturan penskalaan. Nilai default: false.	false
ScalingRuleIds	array	No	ID aturan penskalaan yang akan dikueri.
	string	No	ID aturan penskalaan yang akan dikueri.	asr-bp1dvirgwkoowxk7****
ScalingRuleNames	array	No	Nama aturan penskalaan yang akan dikueri.
	string	No	Nama aturan penskalaan yang akan dikueri.	scalingrule****
ScalingRuleAris	array	No	Pengenal unik aturan penskalaan yang akan dikueri.
	string	No	Pengenal unik aturan penskalaan yang akan dikueri.	ari:acs:ess:cn-hangzhou:140692647406**:scalingrule/asr-bp1dvirgwkoowxk7**

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PageNumber	integer	Nomor halaman saat ini.	1
PageSize	integer	Jumlah entri per halaman.	50
TotalCount	integer	Jumlah total aturan penskalaan.	1
ScalingRules	array<object>	Kumpulan informasi aturan penskalaan.
	array<object>	Kumpulan informasi aturan penskalaan.
MetricName	string	Nama data deret waktu yang terkait dengan tugas alarm aturan penskalaan.	CpuUtilization
AdjustmentType	string	Metode penyesuaian aturan penskalaan. Nilai valid: QuantityChangeInCapacity: Menambahkan atau menghapus sejumlah instans ECS yang ditentukan. PercentChangeInCapacity: Menambahkan atau menghapus persentase instans ECS yang ditentukan. TotalCapacity: Menyesuaikan jumlah instans ECS di grup penskalaan saat ini ke jumlah yang ditentukan.	QuantityChangeInCapacity
InitialMaxSize	integer	Jumlah maksimum instans di grup penskalaan, digunakan bersama dengan PredictiveValueBehavior.	100
EstimatedInstanceWarmup	integer	Pengatur waktu pemanasan yang diperlukan bagi instans yang baru dibuat untuk melakukan serangkaian langkah persiapan. Selama periode pemanasan, instans yang diluncurkan tidak berkontribusi pada data deret waktu pemantauan grup penskalaan.	300
ScaleOutEvaluationCount	integer	Setelah aturan penskalaan pelacakan target dibuat, tugas alarm dibuat secara otomatis. Parameter ini menentukan jumlah kali berturut-turut kondisi ambang batas harus dipenuhi sebelum tugas alarm scale-out yang sesuai Pemicu peringatan.	3
PredictiveScalingMode	string	Mode aturan penskalaan memprediksi. Nilai valid: PredictAndScale: Menghasilkan hasil memprediksi dan membuat tugas memprediksi. PredictOnly: Menghasilkan hasil memprediksi tetapi tidak membuat tugas memprediksi.	PredictAndScale
MinAdjustmentMagnitude	integer	Jumlah minimum instans yang akan disesuaikan untuk aturan penskalaan. Parameter ini hanya berlaku ketika tipe aturan penskalaan adalah SimpleScalingRule atau StepScalingRule dan AdjustmentType adalah PercentChangeInCapacity.	1
ScalingRuleAri	string	Pengenal unik aturan penskalaan.	ari:acs:ess:cn-hangzhou:140692647406**:scalingrule/asr-bp1dvirgwkoowxk7**
PredictiveTaskBufferTime	integer	Tugas memprediksi yang dibuat secara otomatis oleh aturan penskalaan memprediksi dijalankan per jam secara default. Anda dapat mengatur pengatur waktu pra-peluncuran untuk menjalankan tugas memprediksi lebih awal dan menyiapkan resource lebih dulu. Nilai valid: 0 hingga 60. Unit: menit.	30
MinSize	integer	Jumlah minimum instans di grup penskalaan.	1
ScalingGroupId	string	ID grup penskalaan.	asg-bp1ffogfdauy0jw0****
PredictiveValueBehavior	string	Metode yang digunakan untuk handle nilai maksimum dalam aturan penskalaan memprediksi. Nilai valid: MaxOverridePredictiveValue: Nilai maksimum awal menggantikan nilai memprediksi. Ketika nilai memprediksi lebih besar dari nilai maksimum awal, nilai maksimum tugas memprediksi menggunakan nilai maksimum awal. PredictiveValueOverrideMax: Nilai memprediksi menggantikan nilai maksimum awal. Ketika nilai memprediksi lebih besar dari nilai maksimum awal, nilai maksimum tugas memprediksi menggunakan nilai memprediksi. PredictiveValueOverrideMaxWithBuffer: Nilai memprediksi ditingkatkan dengan persentase tertentu. Nilai memprediksi ditingkatkan sebesar persentase PredictiveValueBuffer, dan ketika nilai yang ditingkatkan lebih besar dari nilai maksimum awal, nilai yang ditingkatkan tersebut digunakan.	MaxOverridePredictiveValue
TargetValue	number	Nilai target. Ketika aturan penskalaan adalah aturan penskalaan pelacakan target atau aturan penskalaan memprediksi, aturan penskalaan mempertahankan data deret waktu mendekati nilai target dengan menambahkan atau menghapus instans.	0.125
Cooldown	integer	Pengatur waktu pendinginan aturan penskalaan, hanya berlaku untuk aturan skalabilitas sederhana. Nilai valid: 0 hingga 86400. Unit: detik.	20
MaxSize	integer	Jumlah maksimum instans di grup penskalaan.	2
PredictiveValueBuffer	integer	Parameter ini berlaku ketika PredictiveValueBehavior diatur ke PredictiveValueOverrideMaxWithBuffer. Nilai memprediksi ditingkatkan dengan persentase ini, dan ketika nilai yang ditingkatkan lebih besar dari nilai maksimum awal, nilai yang ditingkatkan tersebut digunakan. Nilai valid: 0 hingga 100.	50
ScalingRuleType	string	Tipe aturan penskalaan. Nilai valid: SimpleScalingRule: aturan skalabilitas sederhana. Menyesuaikan jumlah instans ECS berdasarkan metode penyesuaian (AdjustmentType) dan nilai penyesuaian (AdjustmentValue). TargetTrackingScalingRule: aturan penskalaan pelacakan target. Menghitung secara dinamis jumlah instans ECS yang akan diskalakan berdasarkan data deret waktu yang telah ditentukan sebelumnya (MetricName) dan berupaya mempertahankan nilai data deret waktu mendekati nilai target (TargetValue). StepScalingRule: aturan penskalaan bertahap. Menyediakan penskalaan berbasis langkah berdasarkan ambang batas dan nilai data deret waktu. PredictiveScalingRule: aturan penskalaan memprediksi. Menggunakan pembelajaran mesin untuk menganalisis data pemantauan historis grup penskalaan guna memprediksi nilai data deret waktu di masa mendatang dan mendukung pembuatan otomatis tugas terjadwal untuk menetapkan batas grup penskalaan.	SimpleScalingRule
AdjustmentValue	integer	Nilai penyesuaian aturan penskalaan.	1
ScaleInEvaluationCount	integer	Setelah aturan penskalaan pelacakan target dibuat, tugas alarm dibuat secara otomatis. Parameter ini menentukan jumlah kali berturut-turut kondisi ambang batas harus dipenuhi sebelum tugas alarm scale-in yang sesuai Pemicu peringatan.	15
DisableScaleIn	boolean	Apakah scale-in dinonaktifkan, hanya berlaku untuk aturan penskalaan pelacakan target. Nilai valid: true: Scale-in dinonaktifkan. false: Scale-in diaktifkan.	true
ScalingRuleName	string	Nama aturan penskalaan.	scalingrule****
ScalingRuleId	string	ID aturan penskalaan.	asr-bp1dvirgwkoowxk7****
Alarms	array<object>	Tugas alarm CloudMonitor yang terkait dengan aturan penskalaan. Parameter ini mengembalikan tugas alarm CloudMonitor yang terkait dengan aturan penskalaan hanya ketika parameter ShowAlarmRules diatur ke true. Jika tidak, daftar kosong akan dikembalikan.
	array<object>	Tugas alarm CloudMonitor yang terkait dengan aturan penskalaan. Parameter ini mengembalikan tugas alarm CloudMonitor yang terkait dengan aturan penskalaan hanya ketika parameter ShowAlarmRules diatur ke true. Jika tidak, daftar kosong akan dikembalikan.
AlarmTaskId	string	The ID of the event-triggered task that is associated with the scaling rule.	asg-bp18p2yfxow2dloq**_1f9458d1-70e1-4bee-8c7f-7a47695b**
ComparisonOperator	string	The comparison operator between the statistical value and the threshold of the metric of the event-triggered task that is associated with the scaling rule. The comparison operator indicates the relationship in which the metric value and the metric threshold can meet the alert condition. Valid value if the metric value is greater than or equal to the threshold: >= Valid value if the metric value is less than or equal to the threshold: <= Valid value if the metric value is greater than the threshold: > Valid value if the metric value is less than the threshold: <	>=
MetricName	string	The name of the metric of the event-triggered task that is associated with the scaling rule.	CpuUtilization
EvaluationCount	integer	The number of consecutive times when the event-triggered task that is associated with the scaling rule must meet the alert condition before an alert is triggered.	3
AlarmTaskName	string	The name of the event-triggered task that is associated with the scaling rule.	alarmtask****
MetricType	string	The type of the metric of the event-triggered task that is associated with the scaling rule. Valid values: system: system metrics custom: custom metrics	system
Threshold	number	The alert threshold of the event-triggered task that is associated with the scaling rule.	50
Statistics	string	The statistical method of the event-triggered task that is associated with the scaling rule. Valid values: Average Maximum Minimum	Average
Dimensions	array<object>	The dimensions of the event-triggered task that is associated with the scaling rule.
	object	The dimensions of the event-triggered task that is associated with the scaling rule.
DimensionKey	string	The key of the dimension that is associated with the metric. Valid values: ScalingGroupId: the ID of the scaling group. userId: the ID of the user account.	scaling_group
DimensionValue	string	The value of the dimension that is associated with the metric.	asg-bp18p2yfxow2dloq****
Period	integer	The statistical period of the metric data in the target tracking scaling rule.	60
StepAdjustments	array<object>	Penyesuaian langkah aturan penskalaan bertahap.
	object	Penyesuaian langkah aturan penskalaan bertahap.
MetricIntervalUpperBound	number	The upper limit of a step adjustment. Valid values: -9.999999E18 to 9.999999E18.	5.0
ScalingAdjustment	integer	The number of ECS instances that are scaled in a step adjustment.	1
MetricIntervalLowerBound	number	The lower limit of a step adjustment. Valid values: -9.999999E18 to 9.999999E18.	1.0
AlarmDimensions	array<object>	Nilai informasi dimensi data deret waktu, berlaku untuk aturan penskalaan pelacakan target. Parameter ini diatur ketika data deret waktu memerlukan informasi dimensi tambahan. Misalnya, data deret waktu LoadBalancerRealServerAverageQps memerlukan informasi dimensi rulePool.
	object
DimensionKey	string	The dimension key of the metric.	rulePool
DimensionValue	string	The dimension value of the metric.	sgp-l1cbirz451yxu2dxxx
MetricType	string	Tipe data deret waktu. Nilai valid: system: Menggunakan data deret waktu sistem CloudMonitor. custom: Menggunakan data deret waktu kustom yang dilaporkan ke CloudMonitor. hybrid: Menggunakan data deret waktu Cloud Hibrida.	system
HybridMonitorNamespace	string	ID namespace data deret waktu Cloud Hibrida. Untuk mengelola namespace data deret waktu, lihat Kelola namespace data deret waktu.	aliyun-test
HybridMetrics	array<object>	Pengaturan data deret waktu Cloud Hibrida. Untuk informasi tentang cara mengonfigurasi pengaturan ini, lihat Sesuaikan aturan penskalaan pelacakan target menggunakan operasi rumus.
	array<object>
Id	string	The reference ID of the metric in the metric expression.	a
Expression	string	The metric expression that consists of multiple Hybrid Cloud Monitoring metrics. It calculates a result used to trigger scaling events. The expression is written in Reverse Polish Notation (RPN) format and supports only the following operators: `+, -, *, /`.	(a+b)/2
MetricName	string	The name of the Hybrid Cloud Monitoring metric.	AliyunSmq_NumberOfMessagesVisible
Statistic	string	The statistical method of the metric value. Valid values: Average: The average value of all metric values within a specified interval is calculated. Minimum: The minimum value of all metric values within a specified interval is calculated. Maximum: The maximum value of all metric values within a specified interval is calculated.	Average
Dimensions	array<object>	The metric dimensions. This parameter is used to specify the monitored resources.
	object
DimensionKey	string	The key of the metric dimension.	queue
DimensionValue	string	The key of the metric dimension.	testQueue

Contoh

Respons sukses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "PageNumber": 1,
  "PageSize": 50,
  "TotalCount": 1,
  "ScalingRules": [
    {
      "MetricName": "CpuUtilization",
      "AdjustmentType": "QuantityChangeInCapacity",
      "InitialMaxSize": 100,
      "EstimatedInstanceWarmup": 300,
      "ScaleOutEvaluationCount": 3,
      "PredictiveScalingMode": "PredictAndScale",
      "MinAdjustmentMagnitude": 1,
      "ScalingRuleAri": "ari:acs:ess:cn-hangzhou:140692647406****:scalingrule/asr-bp1dvirgwkoowxk7****",
      "PredictiveTaskBufferTime": 30,
      "MinSize": 1,
      "ScalingGroupId": "asg-bp1ffogfdauy0jw0****",
      "PredictiveValueBehavior": "MaxOverridePredictiveValue",
      "TargetValue": 0.125,
      "Cooldown": 20,
      "MaxSize": 2,
      "PredictiveValueBuffer": 50,
      "ScalingRuleType": "SimpleScalingRule",
      "AdjustmentValue": 1,
      "ScaleInEvaluationCount": 15,
      "DisableScaleIn": true,
      "ScalingRuleName": "scalingrule****",
      "ScalingRuleId": "asr-bp1dvirgwkoowxk7****",
      "Alarms": [
        {
          "AlarmTaskId": "asg-bp18p2yfxow2dloq****_1f9458d1-70e1-4bee-8c7f-7a47695b****",
          "ComparisonOperator": ">=",
          "MetricName": "CpuUtilization",
          "EvaluationCount": 3,
          "AlarmTaskName": "alarmtask****",
          "MetricType": "system",
          "Threshold": 50,
          "Statistics": "Average",
          "Dimensions": [
            {
              "DimensionKey": "scaling_group",
              "DimensionValue": "asg-bp18p2yfxow2dloq****"
            }
          ],
          "Period": 60
        }
      ],
      "StepAdjustments": [
        {
          "MetricIntervalUpperBound": 5,
          "ScalingAdjustment": 1,
          "MetricIntervalLowerBound": 1
        }
      ],
      "AlarmDimensions": [
        {
          "DimensionKey": "rulePool",
          "DimensionValue": "sgp-l1cbirz451yxu2dxxx"
        }
      ],
      "MetricType": "system",
      "HybridMonitorNamespace": "aliyun-test",
      "HybridMetrics": [
        {
          "Id": "a",
          "Expression": "(a+b)/2",
          "MetricName": "AliyunSmq_NumberOfMessagesVisible",
          "Statistic": "Average",
          "Dimensions": [
            {
              "DimensionKey": "queue",
              "DimensionValue": "testQueue"
            }
          ]
        }
      ]
    }
  ]
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.