すべてのプロダクト
Search

このプロダクト

    Microservices Engine:CreateCircuitBreakerRule

    ドキュメントセンター

    Microservices Engine:CreateCircuitBreakerRule

    最終更新日:Dec 16, 2025

    サーキットブレーカールールを作成します。

    今すぐお試しください

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

    create

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Namespace

    string

    必須

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

    default
    AppName

    string

    必須

    アプリケーション名。

    spring-cloud-a
    Threshold

    number

    必須

    サーキットブレーカーをトリガーするためのパーセンテージのしきい値。有効値：0～1。これらの値は 0%～100% を表します。

    0.8
    Enable

    boolean

    必須

    ルールを有効にするかどうかを指定します。

    有効値：

    • true

    • false

    列挙値:

    • true :
    • false :

    true
    Resource

    string

    必須

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

    /a
    AppId

    string

    任意

    アプリケーションの ID。

    hkhon1po62@c3df23522bXXXXX
    RegionId

    string

    任意

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

    cn-hangzhou
    Strategy

    integer

    必須

    しきい値タイプ。

    有効値：

    • 0

      ：

      低速呼び出し比率

    • 1

      ：

      異常比率

    列挙値:

    • 0 :
    • 1 :

    0
    RetryTimeoutMs

    integer

    任意

    サーキットブレーカーが実装される期間。単位：ミリ秒。ルートのリクエストに対してサーキットブレーカーが実装されている場合、設定されたサーキットブレーカー期間中、そのルートへのすべてのリクエストの呼び出しが失敗します。値は 1,000 の整数倍である必要があります。デフォルト値：10000。この値は 10 秒を示します。

    10000
    StatIntervalMs

    integer

    任意

    タイムウィンドウの長さ。単位：ミリ秒。有効範囲は 1 秒から 120 分です。デフォルト値は 20000 です。この値は 20 秒を示します。

    20000
    MaxAllowedRtMs

    integer

    任意

    最大応答時間 (RT)。単位：ミリ秒。リクエストの RT がこのパラメーターの値より大きい場合、低速呼び出しとしてカウントされます。`Strategy` を 0 に設定した場合は、このパラメーターを指定する必要があります。

    200
    MinRequestAmount

    integer

    任意

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

    10
    HalfOpenBaseAmountPerStep

    integer

    任意

    サーキットブレーカーが回復した後、各ステップで渡すことができる最小リクエスト数。デフォルト値：1。

    5
    HalfOpenRecoveryStepNum

    integer

    任意

    サーキットブレーカーの回復ステップ数。デフォルト値：1。

    1
    ResourceType

    integer

    任意

    リソースタイプ。

    有効値：

    • 0：カスタムインターフェイス

    • 1：Web

    • 2：RPC

    • 3：ルート

    • 4：SQL

    列挙値:

    • 0 :
    • 1 :

      WEB

    • 2 :

      RPC

    • 3 :

      ROUTE

    • 4 :

      SQL

    0
    AcceptLanguage

    string

    任意

    応答の言語。有効値：

    • zh：中国語

    • en：英語

    zh

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Message

    string

    返されたメッセージ。

    OK
    RequestId

    string

    リクエスト ID。

    EE5C32A1-BC0E-4B79-817C-103E4EDF****
    Code

    string

    返された応答コード。

    200
    Data

    object

    ルールの詳細。

    Namespace

    string

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

    default
    Id

    integer

    ルールの ID。

    1
    AppName

    string

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

    spring-cloud-a
    Resource

    string

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

    /a
    StatIntervalMs

    integer

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

    20000
    Threshold

    number

    サーキットブレーカーをトリガーするためのパーセンテージのしきい値。有効値：0～1。これらの値は 0%～100% を表します。

    0.8
    Enable

    boolean

    ルールが有効になっているかどうかを示します。

    true
    Strategy

    integer

    しきい値タイプ。

    有効値：

    • 0

      ：

      低速呼び出し比率

    • 1

      ：

      異常比率

    列挙値:

    • 0 :
    • 1 :

    0
    RetryTimeoutMs

    integer

    サーキットブレーカーが実装される期間。単位：ミリ秒。ルートのリクエストに対してサーキットブレーカーが実装されている場合、設定されたサーキットブレーカー期間中、そのルートへのすべてのリクエストの呼び出しが失敗します。

    10000
    AppId

    string

    アプリケーションの ID。

    hkhon1po62@c3df23522bXXXXX
    RegionId

    string

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

    cn-hangzhou
    MaxAllowedRtMs

    integer

    最大応答時間 (RT)。単位：ミリ秒。リクエストの RT がこのパラメーターの値より大きい場合、低速呼び出しとしてカウントされます。`Strategy` を 0 に設定した場合は、このパラメーターを指定する必要があります。

    200
    MinRequestAmount

    integer

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

    10
    HalfOpenBaseAmountPerStep

    integer

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

    5
    HalfOpenRecoveryStepNum

    integer

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

    1
    Success

    boolean

    リクエストが成功したかどうかを示します。

    有効値：

    • true

    • false

    列挙値:

    • true :
    • false :

    true

    例

    成功レスポンス

    JSONJSON

    {
  "Message": "OK",
  "RequestId": "EE5C32A1-BC0E-4B79-817C-103E4EDF****",
  "Code": "200",
  "Data": {
    "Namespace": "default",
    "Id": 1,
    "AppName": "spring-cloud-a",
    "Resource": "/a",
    "StatIntervalMs": 20000,
    "Threshold": 0.8,
    "Enable": true,
    "Strategy": 0,
    "RetryTimeoutMs": 10000,
    "AppId": "hkhon1po62@c3df23522bXXXXX",
    "RegionId": "cn-hangzhou",
    "MaxAllowedRtMs": 200,
    "MinRequestAmount": 10,
    "HalfOpenBaseAmountPerStep": 5,
    "HalfOpenRecoveryStepNum": 1
  },
  "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

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

    変更履歴

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