QueryEventHouse-阿里云帮助中心

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

eventbridge:QueryEventHouse

list

*Table

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

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Query	string	Yes	The query statement. Typically uses a three-part table name in the format catalog.namespace.table.	SELECT * FROM "test-es"."default"."product_info"
Limit	integer	No	The maximum number of rows to return. If a LIMIT clause is already specified in the SQL statement, the SQL's own LIMIT takes precedence.	10

Response elements

Element	Type	Description	Example
	object
Message	string	The error message.	Remote error. requestId: [xxxx], error code: [xxx], message: [The target in event rule is invalid! Endpoint is xxx
RequestId	string	The unique identifier generated by Alibaba Cloud for this request.	f2099962-1628-45f1-9782-2bf6daad823f
Data	object	The returned result.
Rows	array	The list of query result rows.
	Row	A query result row.	{ "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	The number of rows returned.	18
Code	string	The response code. Success: indicates that the request was successful. Other values: indicate error codes. For details about error codes, see Error codes.	Success
Success	boolean	Returns true if the operation is successful.	true

Examples

Success response

JSON format

{
  "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
}

Error codes

HTTP status code	Error code	Error message	Description
403	ServiceNotEnable	Service not enable

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.