Referensi API ListWebFlowRules untuk Aturan Kontrol Aliran HTTP - Microservices Engine - Alibaba Cloud - Microservices Engine

Mengkueri aturan perlindungan parameter panas untuk permintaan HTTP.

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

list

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
Namespace	string	No	Namespace.	default
AppName	string	Yes	Nama aplikasi.	spring-cloud-a
ResourceSearchKey	string	No	Kata kunci antarmuka yang dapat Anda cari dari aturan perlindungan. Parameter ini saling eksklusif dengan parameter Resource.	flow
AppId	string	No	ID aplikasi.	b22qb1**@2f0586be4b1**
Resource	string	No	Antarmuka tempat aturan perlindungan diterapkan. Parameter ini saling eksklusif dengan parameter ResourceSearchKey.	/flow
PageIndex	integer	No	Halaman pertama yang akan diekspor. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri yang akan dikembalikan di setiap halaman.	10
AcceptLanguage	string	No	Bahasa yang digunakan untuk menampilkan hasil yang dikembalikan. Nilai valid: zh (default): Bahasa Mandarin. en: Bahasa Inggris.	zh

Elemen respons

Element	Type	Description	Example
	object
Code	integer	The response code.	200
Message	string	The returned message.	OK
RequestId	string	The request ID.	4AE73569-304C-5AA9-AE11-C1D99C7D1689
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
Data	object	The data returned.
Result	array<object>	The returned results.
	object	Rule information
Namespace	string	The namespace.	default
StatIntervalMs	integer	The length of the time window. Unit: milliseconds.	1000
RuleId	string	The rule ID.	1
AppName	string	The application name.	spring-cloud-a
Resource	string	The name of the interface resource.	/flow
ResourceType	integer	The resource type 0: custom interface 1: WEB 2: RPC	1
ControlBehavior	integer	The flow control method. Valid values: 0: fast failure 2: wait in queue	0
Burst	integer	The number of additional requests allowed for burst requests. The effect is equivalent to the maximum number of tokens for the token bucket algorithm.	0
MaxQueueingTimeMs	integer	The timeout period for queuing when the ControlBehavior parameter is set to 2. Unit: milliseconds.	200
ResourceMode	integer	The resource mode. Valid values: 0: resource name mode	0
Threshold	number	The threshold.	20
Enable	boolean	Indicates whether the rule is enabled or disabled. `true`: enabled. `false`: disabled.	true
ParamItem	string	The parameter description item, which is a JSON string containing the following key-value pairs: parseStrategy: the parameter property (0: client IP address. 1: remote host. 2: header. 3: URL parameter) fieldName: the header name or URL parameter name. You must specify this key only if parseStrategy is set to 2 or 3 matchStrategy: the method to match the property value. You must specify this key only if parseStrategy is set to 2 or 3 and the property value is matched. Valid values: 0 (exact match), 2 (regular expression match), and 3 (substring match) pattern: the match string. You must specify this key only if parseStrategy is set to 2 or 3 and the property value is matched	{"fieldName":"testKey","matchStrategy":2,"parseStrategy":2,"pattern":"testValue"}
AppId	string	The application ID.	hkhon1XXXX@c3df23522bXXXXX
MetricType	integer	The threshold type. Valid values: 1: number of requests	1
RegionId	string	The region ID.	cn-hangzhou
FallbackObject	string	The behavior that was bound to the rule.	{\"appName\":\"spring-cloud-a\",\"fallbackBehavior\":{\"webFallbackMode\":0,\"webRespContentType\":0,\"webRespMessage\":\"Blocked\",\"webRespStatusCode\":429},\"id\":977,\"name\":\"Fallback\",\"namespace\":\"default\",\"resourceClassification\":1}
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries returned per page.	10
TotalSize	integer	The total number of queried rules.	36
HttpStatusCode	integer	The HTTP status code.	200

Contoh

Respons sukses

JSONformat

{
  "Code": 200,
  "Message": "OK",
  "RequestId": "4AE73569-304C-5AA9-AE11-C1D99C7D1689",
  "Success": true,
  "Data": {
    "Result": [
      {
        "Namespace": "default",
        "StatIntervalMs": 1000,
        "RuleId": "1",
        "AppName": "spring-cloud-a",
        "Resource": "/flow",
        "ResourceType": 1,
        "ControlBehavior": 0,
        "Burst": 0,
        "MaxQueueingTimeMs": 200,
        "ResourceMode": 0,
        "Threshold": 20,
        "Enable": true,
        "ParamItem": "{\"fieldName\":\"testKey\",\"matchStrategy\":2,\"parseStrategy\":2,\"pattern\":\"testValue\"}",
        "AppId": "hkhon1XXXX@c3df23522bXXXXX",
        "MetricType": 1,
        "RegionId": "cn-hangzhou",
        "FallbackObject": "{\\\"appName\\\":\\\"spring-cloud-a\\\",\\\"fallbackBehavior\\\":{\\\"webFallbackMode\\\":0,\\\"webRespContentType\\\":0,\\\"webRespMessage\\\":\\\"Blocked\\\",\\\"webRespStatusCode\\\":429},\\\"id\\\":977,\\\"name\\\":\\\"Fallback\\\",\\\"namespace\\\":\\\"default\\\",\\\"resourceClassification\\\":1}"
      }
    ],
    "PageNumber": 1,
    "PageSize": 10,
    "TotalSize": 36
  },
  "HttpStatusCode": 200
}

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.