All Products
Search
Document Center

Microservices Engine:CreateWebFlowRule

Last Updated:Jun 10, 2026

Membuat aturan perlindungan parameter hotspot 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:CreateWebFlowRule

update

*All Resource

*

None None

Parameter permintaan

Parameter

Type

Required

Description

Example

Namespace

string

No

Namespace.

default

AppName

string

Yes

Nama aplikasi.

spring-cloud-a

Threshold

number

Yes

Ambang batas.

20

Enable

boolean

No

Status aturan. Nilai valid:

  • true: diaktifkan

  • false: dinonaktifkan.

Valid values:

  • true :
  • false :

true

Resource

string

Yes

Nama antarmuka. Ini adalah Sumber daya aplikasi tempat aturan diterapkan. Nama antarmuka harus sama dengan nama pada halaman detail antarmuka di Konsol.

/flow

Burst

integer

No

Jumlah permintaan tambahan yang diizinkan untuk Trafik burst. Efeknya setara dengan jumlah maksimum token dalam algoritma token bucket.

0

AppId

string

No

ID aplikasi.

hkhon1****@c3df23522******

ControlBehavior

integer

No

Metode kontrol aliran. Nilai valid:

  • 0: kegagalan cepat

  • 2: menunggu dalam Antrian.

Valid values:

  • 0 :
  • 2 :

0

MaxQueueingTimeMs

integer

No

Periode pengatur waktu habis. Unit: milidetik. Parameter ini diperlukan jika ControlBehavior diatur ke 2.

200

ResourceMode

integer

Yes

Mode Sumber daya. Nilai valid:

  • 0: mode nama Sumber daya.

Valid values:

  • 0 :

0

ParamItem

string

No

Deskripsi parameter, yang merupakan string JSON yang berisi pasangan kunci-nilai berikut:

  • parseStrategy: properti parameter. Nilai valid: 0 (alamat IP Klien), 1 (host jarak jauh), 2 (Header), dan 3 (parameter URL).

  • fieldName: nama Header atau nama parameter URL. Tentukan kunci ini hanya jika parseStrategy diatur ke 2 atau 3.

  • matchStrategy: metode untuk mencocokkan nilai properti. Tentukan kunci ini hanya jika parseStrategy diatur ke 2 atau 3 dan nilai properti dicocokkan. Nilai valid: 0 (kecocokan persis), 2 (kecocokan ekspresi reguler), dan 3 (kecocokan substring).

  • pattern: string kecocokan. Tentukan kunci ini hanya jika parseStrategy diatur ke 2 atau 3 dan nilai properti dicocokkan.

{"fieldName":"testKey","matchStrategy":2,"parseStrategy":2,"pattern":"testValue"}

MetricType

integer

No

Tipe ambang batas. Nilai valid:

  • 1: jumlah permintaan.

Valid values:

  • 1 :

1

StatIntervalMs

integer

No

Panjang jendela pengatur waktu. Unit: milidetik. Nilai default: 1000, yang menunjukkan 1 detik.

1000

RegionId

string

No

ID Wilayah.

cn-hangzhou

ResourceType

integer

No

Tipe Sumber daya. Nilai valid:

  • 0: antarmuka kustom

  • 1: WEB

  • 2: RPC.

Valid values:

  • 0 :
  • 1 :

    WEB.

  • 2 :

    RPC.

1

AcceptLanguage

string

No

Bahasa hasil yang akan dikembalikan. Nilai valid: zh (default): Mandarin. en: Inggris.

zh

Elemen respons

Element

Type

Description

Example

object

Message

string

The response message.

OK

RequestId

string

The request ID.

A73AC37C-C617-4E3A-8049-372CF49C****

Code

string

The response code.

200

Data

object

The response data.

Namespace

string

The namespace.

default

StatIntervalMs

integer

The length of the time window. Unit: milliseconds.

1000

Id

integer

The rule ID.

1

AppName

string

The application name.

spring-cloud-a

Resource

string

Interface name: the application resources to which the rule applies. The interface name must be the same as that displayed on the API details page in the console.

/flow

ControlBehavior

integer

The flow control method. Valid values:

  • 0: fast failure

  • 2: wait in queue

0

ReourceMode

integer

Resource mode

0: resource name mode

0

MaxQueueingTimeMs

integer

The timeout period for queuing when the ControlBehavior parameter is set to 2. Unit: milliseconds.

200

Threshold

number

The threshold.

20

Enable

boolean

The rule status. Valid values:

  • true: enabled

  • false: disabled

true

AppId

string

The application ID.

hkhon1****@c3df23522******

MetricType

integer

The threshold type. Valid values:

  • 1: number of requests

1

RegionId

string

The region ID.

cn-hangzhou

Burst

integer

The number of additional requests allowed for burst requests. The effect is equivalent to the maximum number of tokens of the token bucket algorithm.

0

ParamItem

string

The parameter description, 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"}

Success

boolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.

  • false: The request failed.

true

Contoh

Respons sukses

JSONformat

{
  "Message": "OK",
  "RequestId": "A73AC37C-C617-4E3A-8049-372CF49C****",
  "Code": "200",
  "Data": {
    "Namespace": "default",
    "StatIntervalMs": 1000,
    "Id": 1,
    "AppName": "spring-cloud-a",
    "Resource": "/flow",
    "ControlBehavior": 0,
    "ReourceMode": 0,
    "MaxQueueingTimeMs": 200,
    "Threshold": 20,
    "Enable": true,
    "AppId": "hkhon1****@c3df23522******",
    "MetricType": 1,
    "RegionId": "cn-hangzhou",
    "Burst": 0,
    "ParamItem": "{\"fieldName\":\"testKey\",\"matchStrategy\":2,\"parseStrategy\":2,\"pattern\":\"testValue\"}"
  },
  "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.