すべてのプロダクト
Search

このプロダクト

    :GetAutoThrottleRules

    ドキュメントセンター

    :GetAutoThrottleRules

    最終更新日:Mar 13, 2026

    データベースインスタンスの自動 SQL スロットリングルールを照会します。

    操作説明

    この API オペレーションを呼び出す前に、以下の点にご注意ください。

    • Database Autonomy Service (DAS) の API オペレーションを SDK を使用して呼び出す場合、リージョン ID は cn-shanghai に設定する必要があります。

    • 管理対象のデータベースインスタンスは、以下のいずれかのタイプである必要があります。

      • MySQL 5.6、MySQL 5.7、または MySQL 8.0 を実行する ApsaraDB RDS for MySQL High-availability Edition または Enterprise Edition

      • MySQL 5.6、MySQL 5.7、または MySQL 8.0 を実行する PolarDB for MySQL Cluster Edition

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    hdm:GetAutoThrottleRules

    none

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ConsoleContext

    string

    任意

    予約済みパラメーターです。

    None
    InstanceIds

    string

    任意

    データベースインスタンスの ID です。

    • このパラメーターには、複数のインスタンス ID を含む JSON 配列を指定します。インスタンス ID はカンマ (,) で区切ります。例：['Instance ID1','Instance ID2']。

    • デフォルトでは、このパラメーターを空のままにすると、現在の Alibaba Cloud アカウント内で自動 SQL スロットリング機能が有効化されているすべてのデータベースインスタンスが返されます。返されるインスタンスのタイプは以下のとおりです。

      • 現在、自動 SQL スロットリング機能が有効化されているデータベースインスタンス。

      • 過去に自動 SQL スロットリング機能が有効化されたことがあり、現在は無効化されているデータベースインスタンス（リリース済みのインスタンスは含まれません）。

    ['rm-2ze8g2am97624****','rm-2vc54m2a6pd6p****','rm-2ze9xrhze0709****']

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Code

    integer

    返された HTTP ステータスコードです。

    200
    Message

    string

    返されたメッセージです。

    説明

    リクエストが成功した場合は Successful が返されます。リクエストが失敗した場合は、エラーコードなどの情報を含むエラーメッセージが返されます。

    Successful
    Data

    object

    返されたデータです。

    TotalAutoThrottleRulesCount

    integer

    自動 SQL スロットリング機能が有効化されているデータベースの数です。

    3
    EnableAutoThrottleCount

    integer

    現在、自動 SQL スロットリング機能が有効化されているデータベースインスタンスの数です。

    1
    TurnOffAutoThrottleCount

    integer

    過去に自動 SQL スロットリング機能が有効化されたことがあり、現在は無効化されているデータベースインスタンスの数です。

    1
    NeverEnableAutoThrottleOrReleasedInstanceCount

    integer

    存在しないデータベースインスタンス、または自動 SQL スロットリング機能が一度も有効化されていないデータベースインスタンスの数です。

    説明

    データベースインスタンスが存在しない場合、そのインスタンスはリリース済みであるか、指定されたインスタンス ID が無効です。

    1
    EnableAutoThrottleList

    array<object>

    現在、自動 SQL スロットリング機能が有効化されているデータベースインスタンスです。

    object

    AbnormalDuration

    number

    自動 SQL スロットリングがトリガーされた際に異常が発生する最大期間です。単位：分。

    2
    CpuUsage

    number

    CPU 利用率のしきい値です。

    70
    CpuSessionRelation

    string

    CPU 利用率のしきい値とアクティブセッションの最大数との論理関係です。有効な値：

    • AND

    • OR

    AND
    ActiveSessions

    integer

    アクティブセッションの最大数です。

    32
    MaxThrottleTime

    number

    最大スロットル時間です。単位：分。

    10
    AllowThrottleStartTime

    string

    スロットルウィンドウの開始時刻です。このパラメーターの値は協定世界時 (UTC) です。

    00:00Z
    AllowThrottleEndTime

    string

    スロットルウィンドウの終了時刻です。このパラメーターの値は協定世界時 (UTC) です。

    23:59Z
    Visible

    boolean

    自動 SQL スロットリング機能が有効化されているかどうかを示します。有効な値：

    • true

    • false

    true
    AutoKillSession

    boolean

    実行中の異常な SQL ステートメントを一括で終了するかどうかを示します。有効な値：

    説明

    異常な SQL ステートメントは、スロットル対象となる SQL ステートメントと同じテンプレートを使用します。

    • true

    • false

    true
    InstanceId

    string

    データベースインスタンスの ID です。

    rm-2ze8g2am97624****
    UserId

    string

    データベースインスタンスを作成するために使用された Alibaba Cloud アカウントの ID です。

    140692647406****
    TurnOffAutoThrottleList

    array<object>

    過去に自動 SQL スロットリング機能が有効化されたことがあり、現在は無効化されているデータベースインスタンスです。

    object

    AbnormalDuration

    number

    自動 SQL スロットリングがトリガーされる最大期間です。単位：分。

    2
    CpuUsage

    number

    CPU 利用率のしきい値です。

    80
    AllowThrottleEndTime

    string

    スロットルウィンドウの終了時刻です。このパラメーターの値は協定世界時 (UTC) です。

    23:59Z
    InstanceId

    string

    データベースインスタンスの ID です。

    rm-2ze9xrhze0709****
    Visible

    boolean

    自動 SQL スロットリング機能が有効化されているかどうかを示します。有効な値：

    • true

    • false

    false
    CpuSessionRelation

    string

    CPU 利用率のしきい値とアクティブセッションの最大数との論理関係です。有効な値：

    • AND

    • OR

    OR
    AutoKillSession

    boolean

    実行中の異常な SQL ステートメントを一括で終了するかどうかを示します。有効な値：

    説明

    異常な SQL ステートメントは、スロットル対象となる SQL ステートメントと同じテンプレートを使用します。

    • true

    • false

    true
    ActiveSessions

    integer

    アクティブセッションの最大数です。

    64
    MaxThrottleTime

    number

    最大スロットル時間です。単位：分。

    10
    UserId

    string

    データベースインスタンスを作成するために使用された Alibaba Cloud アカウントの ID です。

    140692647406****
    AllowThrottleStartTime

    string

    スロットルウィンドウの開始時刻です。このパラメーターの値は協定世界時 (UTC) です。

    00:00Z
    NeverEnableAutoThrottleOrReleasedInstanceIdList

    array

    存在しないデータベースインスタンス、または自動 SQL スロットリング機能が一度も有効化されていないデータベースインスタンスの数です。

    説明

    データベースインスタンスが存在しない場合、そのインスタンスはリリース済みであるか、指定されたインスタンス ID が無効です。

    string

    データベースインスタンスの ID です。

    rm-2vc54m2a6pd6p****
    RequestId

    string

    リクエスト ID です。

    7172BECE-588A-5961-8126-C216E16B****
    Success

    boolean

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

    • true

    • false

    true

    例

    成功レスポンス

    JSONJSON

    {
  "Code": 200,
  "Message": "Successful",
  "Data": {
    "TotalAutoThrottleRulesCount": 3,
    "EnableAutoThrottleCount": 1,
    "TurnOffAutoThrottleCount": 1,
    "NeverEnableAutoThrottleOrReleasedInstanceCount": 1,
    "EnableAutoThrottleList": [
      {
        "AbnormalDuration": 2,
        "CpuUsage": 70,
        "CpuSessionRelation": "AND",
        "ActiveSessions": 32,
        "MaxThrottleTime": 10,
        "AllowThrottleStartTime": "00:00Z",
        "AllowThrottleEndTime": "23:59Z",
        "Visible": true,
        "AutoKillSession": true,
        "InstanceId": "rm-2ze8g2am97624****",
        "UserId": "140692647406****"
      }
    ],
    "TurnOffAutoThrottleList": [
      {
        "AbnormalDuration": 2,
        "CpuUsage": 80,
        "AllowThrottleEndTime": "23:59Z",
        "InstanceId": "rm-2ze9xrhze0709****",
        "Visible": false,
        "CpuSessionRelation": "OR",
        "AutoKillSession": true,
        "ActiveSessions": 64,
        "MaxThrottleTime": 10,
        "UserId": "140692647406****",
        "AllowThrottleStartTime": "00:00Z"
      }
    ],
    "NeverEnableAutoThrottleOrReleasedInstanceIdList": [
      "rm-2vc54m2a6pd6p****"
    ]
  },
  "RequestId": "7172BECE-588A-5961-8126-C216E16B****",
  "Success": true
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidParams The request parameters are invalid.
    403 NoPermission You are not authorized to do this action.

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

    変更履歴

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