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

Microservices Engine:ListCircuitBreakerRules

最終更新日:Jun 01, 2026

サーキットブレーカールールをクエリします。

今すぐお試しください

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

list

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

Namespace

string

必須

アプリケーションが属するマイクロサービス 名前空間。

default

AppName

string

必須

アプリケーションの名前。

spring-cloud-a

ResourceSearchKey

string

任意

インターフェイス キーワード保護ルール。

a

AppId

string

任意

アプリケーションの ID です。

hkhon1po62@c3df23522bXXXXX

Resource

string

任意

保護ルールが構成されているインターフェース。

/a

PageIndex

integer

任意

最初のページ番号です。デフォルト値:1。

1

PageSize

integer

任意

1ページあたりのエントリ数。デフォルト値: 6 。

10

AcceptLanguage

string

任意

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

zh

レスポンスフィールド

パラメーター

説明

object

Code

integer

応答コード。

200

Message

string

レスポンスメッセージ。

OK

RequestId

string

リクエストの ID です。

4E9FDCFE-0738-493B-B801-82BDFBCB****

Success

boolean

リクエストの結果。

true

Data

object

ルール。

Result

array

返された結果。

object

Namespace

string

アプリケーションが属するマイクロサービス 名前空間。

default

RuleId

integer

ルールの ID です。

1

AppName

string

アプリケーションの名前。

spring-cloud-a

Resource

string

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

/a

ResourceType

integer

インターフェイス リソースタイプ。

Strategy

integer

しきい値のタイプ。

0

Threshold

number

回路遮断をトリガーするためのパーセンテージのしきい値。有効な値: 0~1。これらの値は 0%~100% を表します。

0.8

Enable

boolean

ルールが有効かどうかを示します。

true

RetryTimeoutMs

integer

サーキットブレーカーが実装される期間。単位:ミリ秒。リソースに対してサーキットブレーカーが実装されている場合、設定された期間中はすべてのリクエストがすぐに失敗します。

10000

StatIntervalMs

integer

タイムウィンドウの長さ。単位:ミリ秒。有効値は 1 秒から 120 分です。

20000

AppId

string

アプリケーションの ID。

hkhon1po62@c3df23522bXXXXX

RegionId

string

クラスタが存在するリージョン。

cn-hangzhou

FallbackObject

string

ルールにバインドされた動作。

"{\"appName\":\"spring-cloud-a\",\"fallbackBehavior\":{\"webFallbackMode\":0,\"webRespContentType\":0,\"webRespMessage\":\"Blocked\",\"webRespStatusCode\":429},\"id\":977,\"name\":\"Fallback\",\"namespace\":\"default\",\"resourceClassification\":1}"

MaxAllowedRtMs

integer

最大 RT。単位:ミリ秒。リクエストの RT がこのパラメーターの値よりも大きい場合、低速呼び出しとしてカウントされます。ストラテジーを 0 に設定した場合、このパラメーターを指定する必要があります。

200

MinRequestAmount

integer

サーキットブレーカーをトリガーする最小リクエスト数。 現在のタイムウィンドウ内のリクエスト数がこのパラメーターの値未満の場合、サーキットブレーカーのルールが満たされていても、サーキットブレーカーはトリガーされません。

10

HalfOpenBaseAmountPerStep

integer

サーキットブレーカーの回復後、各ステップで渡すことができるリクエストの最小数。

5

HalfOpenRecoveryStepNum

integer

サーキットブレーカー回復ステップの数。

1

PageNumber

integer

最初のページ番号。

1

PageSize

integer

1ページあたりのエントリ数。

10

TotalSize

integer

ページの総数。

3

HttpStatusCode

integer

HTTP ステータスコード

200

成功レスポンス

JSONJSON

{
  "Code": 200,
  "Message": "OK",
  "RequestId": "4E9FDCFE-0738-493B-B801-82BDFBCB****",
  "Success": true,
  "Data": {
    "Result": [
      {
        "Namespace": "default",
        "RuleId": 1,
        "AppName": "spring-cloud-a",
        "Resource": "/a",
        "ResourceType": 0,
        "Strategy": 0,
        "Threshold": 0.8,
        "Enable": true,
        "RetryTimeoutMs": 10000,
        "StatIntervalMs": 20000,
        "AppId": "hkhon1po62@c3df23522bXXXXX",
        "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}\"",
        "MaxAllowedRtMs": 200,
        "MinRequestAmount": 10,
        "HalfOpenBaseAmountPerStep": 5,
        "HalfOpenRecoveryStepNum": 1
      }
    ],
    "PageNumber": 1,
    "PageSize": 10,
    "TotalSize": 3
  },
  "HttpStatusCode": 200
}

エラーコード

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

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

変更履歴

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