Gunakan ListGatewayCircuitBreakerRule untuk kueri aturan circuit breaker gateway - Microservices Engine - Alibaba Cloud - Microservices Engine

Mengkueri aturan circuit breaker dari gateway.

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

list

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
FilterParams	string	Yes	hanya untuk POP	param
AcceptLanguage	string	No	Bahasa yang digunakan untuk menampilkan hasil yang dikembalikan. Nilai yang valid: zh (default): Tionghoa, en: Inggris	zh

Elemen respons

Element	Type	Description	Example
	object	RestResult<PageResult>
RequestId	string	ID permintaan.	DC34E4A3-5F1C-4E40-86EA-02EDF967****
Data	object	Data yang dikembalikan.
PageNumber	integer	Nomor halaman dari daftar instans	1
TotalSize	integer	Jumlah total instans yang dikueri	11
PageSize	integer	Jumlah baris per halaman yang ditetapkan saat input	100
Result	array<object>	Hasil yang dikembalikan.
	object	Koleksi yang dikembalikan.
Id	integer	The circuit breaker rule ID.	467
GatewayId	integer	The gateway ID.	11919
GatewayUniqueId	string	The unique ID of the gateway.	gw-5017305290e14centbrveca****
RouteId	integer	The route ID.	3091
RouteName	string	The route name.	routeName
Strategy	integer	The threshold pattern. 0: Slow call pattern. 1: Exception pattern.	0
TriggerRatio	integer	The percentage to trigger circuit breaking.	10
StatDurationSec	integer	The circuit breaking statistics duration.	11
RecoveryTimeoutSec	integer	The circuit breaking recovery duration.	12
MinRequestAmount	integer	The minimum number of requests to trigger circuit breaking.	10
MaxAllowedMs	integer	The slow call threshold in slow call pattern.	14
LimitMode	integer	The threshold conversion mode. 0: Single machine. 1: Cluster. 2: Cluster to single machine.	0
BehaviorType	integer	The Web fallback behavior type. 0: Return specified content. 1: Redirect to a specified page.	0
BodyEncoding	integer	The encoding type. 0: Plain text 1: JSON	0
ResponseStatusCode	integer	The HTTP status code.	204
ResponseContentBody	string	The HTTP response text.	text
ResponseRedirectUrl	string	The redirect URL.	www.******.com
ResponseAdditionalHeaders	string	The custom header, input as key-value pairs.	key=value
Enable	integer	Whether to enable. 0: Not enabled. 1: Enabled.	0
IdList	array	The filter rule id
	integer	The rule ID.	467
Results	array<object>	Koleksi hasil yang dikembalikan.
	object	Koleksi yang dikembalikan.
Id	integer	The circuit breaker rule ID.	467
GatewayId	integer	The gateway ID.	11919
GatewayUniqueId	string	The unique ID of the gateway.	gw-1ee34548c68f4778a25c05abd657****
RouteId	integer	The route ID.	3450
RouteName	string	The route name.	routeName
Strategy	integer	The threshold pattern. 0: Slow call pattern. 1: Exception pattern.	0
TriggerRatio	integer	The percentage to trigger circuit breaking.	10
StatDurationSec	integer	The circuit breaking statistics duration.	11
RecoveryTimeoutSec	integer	The circuit breaking recovery duration.	12
MinRequestAmount	integer	The minimum number of requests to trigger circuit breaking.	10
MaxAllowedMs	integer	The slow call threshold in slow call pattern.	10
LimitMode	integer	The threshold conversion mode. 0: Single machine. 1: Cluster. 2: Cluster to single machine.	0
BehaviorType	integer	The Web fallback behavior type. 0: Return specified content 1: Redirect to a specified page	0
BodyEncoding	integer	The encoding type. 0: Plain text 1: JSON	0
ResponseStatusCode	integer	The HTTP status code.	204
ResponseContentBody	string	The HTTP response text.	text
ResponseRedirectUrl	string	The redirect URL.	www.******.com
ResponseAdditionalHeaders	string	The custom header, input as key-value pairs.	key=value
Enable	integer	Whether to enable. 0: Not enabled. 1: Enabled.	0
IdList	array	The filter rule id
	integer	The rule ID.	467

Contoh

Respons sukses

JSONformat

{
  "RequestId": "DC34E4A3-5F1C-4E40-86EA-02EDF967****",
  "Data": {
    "PageNumber": 1,
    "TotalSize": 11,
    "PageSize": 100,
    "Result": [
      {
        "Id": 467,
        "GatewayId": 11919,
        "GatewayUniqueId": "gw-5017305290e14centbrveca****",
        "RouteId": 3091,
        "RouteName": "routeName",
        "Strategy": 0,
        "TriggerRatio": 10,
        "StatDurationSec": 11,
        "RecoveryTimeoutSec": 12,
        "MinRequestAmount": 10,
        "MaxAllowedMs": 14,
        "LimitMode": 0,
        "BehaviorType": 0,
        "BodyEncoding": 0,
        "ResponseStatusCode": 204,
        "ResponseContentBody": "text",
        "ResponseRedirectUrl": "www.******.com",
        "ResponseAdditionalHeaders": "key=value",
        "Enable": 0,
        "IdList": [
          467
        ]
      }
    ],
    "Results": [
      {
        "Id": 467,
        "GatewayId": 11919,
        "GatewayUniqueId": "gw-1ee34548c68f4778a25c05abd657****",
        "RouteId": 3450,
        "RouteName": "routeName",
        "Strategy": 0,
        "TriggerRatio": 10,
        "StatDurationSec": 11,
        "RecoveryTimeoutSec": 12,
        "MinRequestAmount": 10,
        "MaxAllowedMs": 10,
        "LimitMode": 0,
        "BehaviorType": 0,
        "BodyEncoding": 0,
        "ResponseStatusCode": 204,
        "ResponseContentBody": "text",
        "ResponseRedirectUrl": "www.******.com",
        "ResponseAdditionalHeaders": "key=value",
        "Enable": 0,
        "IdList": [
          467
        ]
      }
    ]
  }
}

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.