Gunakan API CreateCircuitBreakerRule - Microservices Engine - Alibaba Cloud - Microservices Engine

Membuat aturan circuit breaking.

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

mse:CreateCircuitBreakerRule

create

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
Namespace	string	Yes	Namespace microservice tempat aplikasi berada.	default
AppName	string	Yes	Nama aplikasi.	spring-cloud-a
Threshold	number	Yes	Ambang batas persentase untuk memicu circuit breaking. Nilai yang valid: 0 hingga 1. Nilai ini mewakili 0% hingga 100%.	0.8
Enable	boolean	Yes	Menentukan apakah akan mengaktifkan aturan. Nilai yang valid: true false . Valid values: true : false :	true
Resource	string	Yes	Nama interface tempat aturan diterapkan. Nama interface harus sama dengan nama pada halaman detail interface di konsol.	/a
AppId	string	No	ID aplikasi.	hkhon1po62@c3df23522bXXXXX
RegionId	string	No	Region tempat instance berada.	cn-hangzhou
Strategy	integer	Yes	Jenis ambang batas. Nilai yang valid: 0 : proporsi panggilan lambat 1 : proporsi abnormal . Valid values: 0 : 1 :	0
RetryTimeoutMs	integer	No	Periode saat circuit breaking aktif. Unit: milidetik. Ketika circuit breaking dipicu untuk sebuah route, semua panggilan ke route tersebut gagal selama periode ini. Nilainya harus kelipatan bilangan bulat dari 1.000. Nilai default: 10000. Nilai ini menunjukkan 10 detik.	10000
StatIntervalMs	integer	No	Panjang jendela waktu. Unit: milidetik. Nilai yang valid: 1 detik hingga 120 menit. Nilai default: 20000. Nilai ini menunjukkan 20 detik.	20000
MaxAllowedRtMs	integer	No	Waktu respons maksimum (RT). Unit: milidetik. Jika RT dari sebuah permintaan lebih besar dari nilai parameter ini, permintaan tersebut dihitung sebagai panggilan lambat. Jika Anda menetapkan Strategy ke 0, Anda harus menentukan parameter ini.	200
MinRequestAmount	integer	No	Jumlah minimum permintaan yang diperlukan untuk memicu circuit breaking. Jika jumlah permintaan dalam jendela waktu saat ini kurang dari nilai ini, circuit breaking tidak akan dipicu meskipun aturan terpenuhi. Nilai default: 10.	10
HalfOpenBaseAmountPerStep	integer	No	Jumlah minimum permintaan yang dapat lolos pada setiap langkah setelah circuit breaking pulih. Nilai default: 1.	5
HalfOpenRecoveryStepNum	integer	No	Jumlah langkah pemulihan circuit breaking. Nilai default: 1.	1
ResourceType	integer	No	Jenis resource. Nilai yang valid: 0: interface kustom 1: web 2: RPC 3: route 4: SQL. Valid values: 0 : 1 : WEB 2 : RPC 3 : ROUTE 4 : SQL	0
AcceptLanguage	string	No	Bahasa respons. Nilai yang valid: zh: Mandarin en: Inggris.	zh

Elemen respons

Element	Type	Description	Example
	object
Message	string	Pesan yang dikembalikan.	OK
RequestId	string	ID permintaan.	EE5C32A1-BC0E-4B79-817C-103E4EDF****
Code	string	Kode respons yang dikembalikan.	200
Data	object	Detail aturan.
Namespace	string	Namespace microservice tempat aplikasi berada.	default
Id	integer	ID aturan.	1
AppName	string	Nama aplikasi.	spring-cloud-a
Resource	string	Nama interface yang dapat diterapkan aturan. Nama interface harus sama dengan nama pada halaman detail interface di konsol.	/a
StatIntervalMs	integer	Panjang jendela waktu. Unit: milidetik. Rentang yang valid adalah dari 1 detik hingga 120 menit.	20000
Threshold	number	Ambang batas persentase untuk memicu circuit breaking. Nilai yang valid: 0-1. Nilai ini mewakili 0% hingga 100%.	0.8
Enable	boolean	Menunjukkan apakah aturan diaktifkan.	true
Strategy	integer	Jenis ambang batas. Nilai yang valid: 0 : Rasio panggilan lambat 1 : Proporsi abnormal Valid values: 0 : 1 :	0
RetryTimeoutMs	integer	Periode saat circuit breaking diterapkan. Unit: milidetik. Jika circuit breaking diterapkan pada permintaan untuk route, semua panggilan ke permintaan untuk route tersebut akan gagal pada periode circuit breaking yang dikonfigurasi.	10000
AppId	string	ID aplikasi.	hkhon1po62@c3df23522bXXXXX
RegionId	string	Region tempat instance berada.	cn-hangzhou
MaxAllowedRtMs	integer	Waktu respons maksimum (RT). Unit: milidetik. Jika RT dari sebuah permintaan lebih besar dari nilai parameter ini, sebuah panggilan lambat akan dihitung. Jika Anda menetapkan Strategy ke 0, Anda harus menentukan parameter ini.	200
MinRequestAmount	integer	Jumlah minimum permintaan untuk memicu circuit breaking. Jika jumlah permintaan dalam jendela waktu saat ini kurang dari nilai parameter ini, circuit breaking tidak akan dipicu meskipun aturan circuit breaking terpenuhi.	10
HalfOpenBaseAmountPerStep	integer	Jumlah minimum permintaan yang dapat lolos pada setiap langkah setelah circuit breaking pulih.	5
HalfOpenRecoveryStepNum	integer	Jumlah langkah pemulihan circuit breaking.	1
Success	boolean	Menunjukkan apakah permintaan berhasil. Nilai yang valid: true false Valid values: true : false :	true

Contoh

Respons sukses

JSONformat

{
  "Message": "OK",
  "RequestId": "EE5C32A1-BC0E-4B79-817C-103E4EDF****",
  "Code": "200",
  "Data": {
    "Namespace": "default",
    "Id": 1,
    "AppName": "spring-cloud-a",
    "Resource": "/a",
    "StatIntervalMs": 20000,
    "Threshold": 0.8,
    "Enable": true,
    "Strategy": 0,
    "RetryTimeoutMs": 10000,
    "AppId": "hkhon1po62@c3df23522bXXXXX",
    "RegionId": "cn-hangzhou",
    "MaxAllowedRtMs": 200,
    "MinRequestAmount": 10,
    "HalfOpenBaseAmountPerStep": 5,
    "HalfOpenRecoveryStepNum": 1
  },
  "Success": true
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.