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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

eventbridge:QueryEventHouse

list

*Table

acs:eventbridge:{#regionId}:{#accountId}:table/{#TableId}

なし

リクエスト構文

POST  HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Query	string	必須	クエリステートメント。通常、catalog.namespace.table 形式の 3 部構成のテーブル名を使用します。	SELECT * FROM "test-es"."default"."product_info"
Limit	integer	任意	返却する行の最大数。SQL ステートメント内で LIMIT 句がすでに指定されている場合は、SQL 自体の LIMIT が優先されます。	10

レスポンスフィールド

フィールド	型	説明	例
	object
Message	string	エラーメッセージ。	Remote error. requestId: [xxxx], error code: [xxx], message: [The target in event rule is invalid! Endpoint is xxx
RequestId	string	このリクエストに対して Alibaba Cloud が生成した一意の識別子。	f2099962-1628-45f1-9782-2bf6daad823f
Data	object	返却された結果。
Rows	array	クエリ結果の行のリスト。
	Row	クエリ結果の 1 行。	{ "columns": [ { "column_name": "index", "column_type": "varchar", "column_value": "product_info", "is_null": false }, { "column_name": "docs.count", "column_type": "bigint", "column_value": "0", "is_null": false } ] }
Total	integer	返却された行数。	18
Code	string	レスポンスコード。Success: リクエストが成功したことを示します。その他の値: エラーコードを示します。エラーコードの詳細については、「エラーコード」を参照してください。	Success
Success	boolean	操作が成功した場合は true を返します。	true

例

成功レスポンス

JSONJSON

{
  "Message": "Remote error. requestId: [xxxx], error code: [xxx], message: [The target in event rule is invalid! Endpoint is xxx",
  "RequestId": "f2099962-1628-45f1-9782-2bf6daad823f",
  "Data": {
    "Rows": [
      {
        "Columns": [
          {
            "Name": "index",
            "Type": "text",
            "Value": "product_info",
            "IsNull": false
          }
        ]
      }
    ],
    "Total": 18
  },
  "Code": "Success",
  "Success": true
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
403	ServiceNotEnable	サービスが有効化されていません

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

変更履歴

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