GetRunningSqlConcurrencyControlRules - - Alibaba Cloud ドキュメントセンター

有効な速度制限ルールを照会します。

操作説明

この操作は、次のデータベースエンジンをサポートしています。

ApsaraDB RDS for MySQL
PolarDB for MySQL

今すぐお試しください

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

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ConsoleContext	string	任意	予約済みのパラメーターです。	None
InstanceId	string	必須	インスタンス ID。説明データベースインスタンスが ApsaraDB RDS for MySQL インスタンスまたは PolarDB for MySQL クラスターである場合にのみ、このパラメーターを指定します。	rm-2ze1jdv45i7l6****
PageNo	integer	任意	ページ番号。値は正の整数である必要があります。デフォルト値：1。	1
PageSize	integer	任意	ページあたりのエントリ数。値は正の整数である必要があります。デフォルト値：10。	10

レスポンスフィールド

フィールド	型	説明	例
	object
Code	string	返される HTTP ステータスコード。	200
Message	string	返されたメッセージ。説明リクエストが成功した場合、`Successful` が返されます。リクエストが失敗した場合、エラーコードなどのエラーメッセージが返されます。	Successful
Data	object	エラーコードや返されるエントリ数などの詳細情報。
Total	integer	返されたエントリの総数。	2
List	object
runningRules	array<object>	返されたデータ。
	object
ItemId	integer	インスタンスに適用される速度制限ルールの ID。	16
SqlType	string	SQL 文のタイプ。有効な値： SELECT UPDATE DELETE	SELECT
InstanceId	string	インスタンス ID。	rm-2ze1jdv45i7l6****
SqlKeywords	string	速度制限ルールが適用された SQL 文に含まれるキーワード。説明 SQL キーワードはチルダ (~) で区切られます。指定されたすべての SQL キーワードを含む同時実行 SQL 文の数が指定された上限に達すると、速度制限ルールがトリガーされます。	call~open~api~test~4~from~POP
StartTime	integer	速度制限ルールが有効になった時刻。値は、協定世界時 (UTC) 1970 年 1 月 1 日 00:00:00 から経過したミリ秒数を表す UNIX タイムスタンプです。	1608888296000
KeywordsHash	string	SQL キーワードのハッシュ値。ハッシュ値は、速度制限ルールが適用される SQL 文に含まれる SQL キーワードに基づいて計算されます。	b0b8aceeb43baea87b219c81767b****
ConcurrencyControlTime	integer	SQL 速度制限ルールが有効な期間。単位：秒。説明速度制限ルールはこの期間内でのみ有効です。	600
UserId	string	Alibaba Cloud アカウント ID。	testxxx
MaxConcurrency	string	同時実行 SQL 文の最大数。値は正の整数です。説明指定されたキーワードを含む同時実行 SQL 文の数がこの上限に達すると、速度制限ルールがトリガーされます。	2
Status	string	速度制限ルールのステータス。値 Open は、速度制限ルールが有効であることを示します。	Open
RequestId	string	リクエスト ID。	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	string	リクエストが成功したかどうかを示します。有効な値： true false	true

例

成功レスポンス

JSONJSON

{
  "Code": "200",
  "Message": "Successful",
  "Data": {
    "Total": 2,
    "List": {
      "runningRules": [
        {
          "ItemId": 16,
          "SqlType": "SELECT",
          "InstanceId": "rm-2ze1jdv45i7l6****",
          "SqlKeywords": "call~open~api~test~4~from~POP",
          "StartTime": 1608888296000,
          "KeywordsHash": "b0b8aceeb43baea87b219c81767b****",
          "ConcurrencyControlTime": 600,
          "UserId": "testxxx",
          "MaxConcurrency": "2",
          "Status": "Open"
        }
      ]
    }
  },
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

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

変更履歴

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