すべてのプロダクト
Search
ドキュメントセンター

Microservices Engine:CreateWebFlowRule

最終更新日:Jun 01, 2026

HTTP リクエストのホット パラメーター保護ルールを作成します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

mse:CreateWebFlowRule

update

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

Namespace

string

任意

名前空間

default

AppName

string

必須

アプリケーション名

spring-cloud-a

Threshold

number

必須

しきい値

20

Enable

boolean

任意

ルールのステータス

  • true(有効)

  • false(無効)

true

Resource

string

必須

ルールが適用されるインターフェースの名前。インターフェース名は、コンソールインターフェースの詳細ページの名前と同じである必要があります。

/flow

Burst

integer

任意

バースト リクエストで許可される追加リクエストの数。効果は、トークン バケット アルゴリズムの最大トークン数と同等です。

0

AppId

string

任意

アプリケーション ID

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

ControlBehavior

integer

任意

フロー制御方式。有効な値:

  • 0(高速失敗)

  • 2(キューで待機)

0

MaxQueueingTimeMs

integer

任意

タイムアウト期間。単位:ミリ秒。 ControlBehavior パラメーターが 2 に設定されている場合、このパラメーターは必須です。

200

ResourceMode

integer

必須

リソース モード

  • 0 (リソース名モード)

0

ParamItem

string

任意

パラメーター記述アイテム。これは、次のキーと値のペアを含む JSON 文字列です。

  • parseStrategy:パラメーター プロパティ(0:クライアント IP アドレス、1:リモート ホスト、2:ヘッダー、3:URL パラメーター)

  • fieldName:ヘッダー名または URL パラメーター名。 parseStrategy が 2 または 3 に設定されている場合にのみ、このキーを指定する必要があります。

  • matchStrategy:プロパティ値を照合する方法。 parseStrategy が 2 または 3 に設定されていて、プロパティ値が照合される場合にのみ、このキーを指定する必要があります。有効な値:0(完全一致)、2(正規表現一致)、および 3(部分文字列一致)

  • pattern:一致文字列。 parseStrategy が 2 または 3 に設定されていて、プロパティ値が照合される場合にのみ、このキーを指定する必要があります。

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

MetricType

integer

任意

しきい値のタイプ。有効な値:

  • 1(リクエスト数)

1

StatIntervalMs

integer

任意

タイム ウィンドウの長さ。単位:ミリ秒。デフォルト値は 1000 で、1 秒を示します。

1000

RegionId

string

任意

リージョン ID。

cn-hangzhou

ResourceType

integer

任意

リソース タイプ

  • 0 (カスタム インターフェース)

  • 1 (WEB)

  • 2 (RPC)

1

AcceptLanguage

string

任意

結果を表示する言語。有効な値: zh (デフォルト):中国語。 en:英語

zh

レスポンスフィールド

パラメーター

説明

object

Message

string

応答メッセージ。

OK

RequestId

string

リクエスト ID。

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

Code

string

レスポンス コード。

200

Data

object

応答データ。

Namespace

string

名前空間。

default

StatIntervalMs

integer

タイム ウィンドウの長さ。単位:ミリ秒。

1000

Id

integer

ルール ID。

1

AppName

string

アプリケーション名。

spring-cloud-a

Resource

string

ルールが適用されるインターフェースの名前。インターフェース名は、コンソールの [API の詳細] ページに表示される名前と同じである必要があります。

/flow

ControlBehavior

integer

フロー制御方式。有効な値:

  • 0(高速失敗)

  • 2(キューで待機)

0

ReourceMode

integer

リソース モード

0 (リソース名モード)

0

MaxQueueingTimeMs

integer

ControlBehavior パラメーターが 2 に設定されている場合のキューイングのタイムアウト期間。単位:ミリ秒。

200

Threshold

number

しきい値。

20

Enable

boolean

ルールのステータス。有効な値:

  • true(有効)

  • false(無効)

true

AppId

string

アプリケーション ID。

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

MetricType

integer

しきい値のタイプ。有効な値:

  • 1(リクエスト数)

1

RegionId

string

リージョン ID。

cn-hangzhou

Burst

integer

バースト リクエストで許可される追加リクエストの数。効果は、トークン バケット アルゴリズムの最大トークン数と同等です。

0

ParamItem

string

パラメーター記述アイテム。これは、次のキーと値のペアを含む JSON 文字列です。

  • parseStrategy:パラメーター プロパティ(0:クライアント IP アドレス、1:リモート ホスト、2:ヘッダー、3:URL パラメーター)

  • fieldName:ヘッダー名または URL パラメーター名。 parseStrategy が 2 または 3 に設定されている場合にのみ、このキーを指定する必要があります

  • matchStrategy:プロパティ値を照合する方法。 parseStrategy が 2 または 3 に設定されていて、プロパティ値が照合される場合にのみ、このキーを指定する必要があります。有効な値:0(完全一致)、2(正規表現一致)、および 3(部分文字列一致)

  • pattern:一致文字列。 parseStrategy が 2 または 3 に設定されていて、プロパティ値が照合される場合にのみ、このキーを指定する必要があります

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

Success

boolean

リクエストが成功したかどうかを示します。有効な値:

  • true:リクエストは成功しました。

  • false:リクエストは失敗しました。

true

成功レスポンス

JSONJSON

{
  "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
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 IllegalRequest Invalid request:%s
400 InvalidParameter Parameter error:%s
500 InternalError Console error. Try again later:%s
403 NoPermission You are not authorized to perform this operation:%s
404 NotFound Not found:%s

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。