ListGatewayCircuitBreakerRule - Microservices Engine - Alibaba Cloud ドキュメントセンター

ゲートウェイのサーキットブレーカールールをクエリします。

今すぐお試しください

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

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
FilterParams	string	必須	POP 専用	param
AcceptLanguage	string	任意	返される結果が表示される言語。有効な値：zh（デフォルト）：中国語、en：英語	zh

レスポンスフィールド

パラメーター	型	説明	例
	object	RestResult<PageResult>
RequestId	string	リクエスト ID。	DC34E4A3-5F1C-4E40-86EA-02EDF967****
Data	object	返されたデータ。
PageNumber	integer	インスタンスリストのページ番号	1
TotalSize	integer	クエリされたインスタンスの総数	11
PageSize	integer	入力時に設定された1ページあたりの行数	100
Result	array	返された結果。
	object	返されたコレクション。
Id	integer	サーキットブレーカールール ID。	467
GatewayId	integer	ゲートウェイ ID。	11919
GatewayUniqueId	string	ゲートウェイの一意の ID。	gw-5017305290e14centbrveca****
RouteId	integer	ルート ID。	3091
RouteName	string	ルート名。	routeName
Strategy	integer	しきい値パターン。 0：低速呼び出しパターン。 1：例外パターン。	0
TriggerRatio	integer	サーキットブレークをトリガーするパーセンテージ。	10
StatDurationSec	integer	サーキットブレークの統計期間。	11
RecoveryTimeoutSec	integer	サーキットブレークの回復期間。	12
MinRequestAmount	integer	サーキットブレークをトリガーする最小リクエスト数。	10
MaxAllowedMs	integer	低速呼び出しパターンでの低速呼び出しのしきい値。	14
LimitMode	integer	しきい値変換モード。 0：単一マシン。 1：クラスタ。 2：クラスタから単一マシン。	0
BehaviorType	integer	Web フォールバック動作タイプ。 0：指定されたコンテンツを返す。 1：指定されたページにリダイレクトする。	0
BodyEncoding	integer	エンコードタイプ。 0：プレーンテキスト 1：JSON	0
ResponseStatusCode	integer	HTTP ステータスコード。	204
ResponseContentBody	string	HTTP 応答テキスト。	text
ResponseRedirectUrl	string	リダイレクト URL。	www.******.com
ResponseAdditionalHeaders	string	カスタムヘッダー。キーと値のペアとして入力します。	key=value
Enable	integer	有効にするかどうか。 0：無効。 1：有効。	0
IdList	array	フィルタールール ID
	integer	ルール ID。	467
Results	array	返された結果コレクション。
	object	返されたコレクション。
Id	integer	サーキットブレーカールール ID。	467
GatewayId	integer	ゲートウェイ ID。	11919
GatewayUniqueId	string	ゲートウェイの一意の ID。	gw-1ee34548c68f4778a25c05abd657****
RouteId	integer	ルート ID。	3450
RouteName	string	ルート名。	routeName
Strategy	integer	しきい値パターン。 0：低速呼び出しパターン。 1：例外パターン。	0
TriggerRatio	integer	サーキットブレークをトリガーするパーセンテージ。	10
StatDurationSec	integer	サーキットブレークの統計期間。	11
RecoveryTimeoutSec	integer	サーキットブレークの回復期間。	12
MinRequestAmount	integer	サーキットブレークをトリガーする最小リクエスト数。	10
MaxAllowedMs	integer	低速呼び出しパターンでの低速呼び出しのしきい値。	10
LimitMode	integer	しきい値変換モード。 0：単一マシン。 1：クラスタ。 2：クラスタから単一マシン。	0
BehaviorType	integer	Web フォールバック動作タイプ。 0：指定されたコンテンツを返す 1：指定されたページにリダイレクトする	0
BodyEncoding	integer	エンコードタイプ。 0：プレーンテキスト 1：JSON	0
ResponseStatusCode	integer	HTTP ステータスコード。	204
ResponseContentBody	string	HTTP 応答テキスト。	text
ResponseRedirectUrl	string	リダイレクト URL。	www.******.com
ResponseAdditionalHeaders	string	カスタムヘッダー。キーと値のペアとして入力します。	key=value
Enable	integer	有効にするかどうか。 0：無効。 1：有効。	0
IdList	array	フィルタールール ID
	integer	ルール ID。	467

例

成功レスポンス

JSONJSON

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

エラーコード

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

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

変更履歴

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