ExecuteQuery-AgentLoop(AgentLoop)-阿里云帮助中心

Executes a query statement.

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

agentloop:ExecuteQuery

update

*Dataset

acs:agentloop:{#regionId}:{#accountId}:agentspace/{#AgentSpaceName}/dataset/{#DatasetName}

None

Request syntax

POST /agentspace/{agentSpace}/dataset/{datasetName}/query HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
agentSpace	string	Yes	The name of the agent space.	sop-agent
datasetName	string	Yes	The name of the dataset.	product_faq_dataset

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body parameters.
type	string	Yes	The statement type. Currently, only SQL is supported.	SQL
query	string	Yes	The query entered by the user.	select count(*) from product_faq_dataset
maxOutputLength	integer	No
from	integer	No
to	integer	No
offset	integer	No
length	integer	No
version	string	No

Response elements

Element	Type	Description	Example
	object	Schema of Response
requestId	string	The request ID.	EB27D183-8F6C-5C5A-A6A3-E0508AF54F78
meta	object	The metadata of the returned data.
affectedRows	integer	The number of log rows scanned or processed.	100
elapsedMillisecond	integer	The time consumed by this execution, in milliseconds.	15
progress	string	Indicates whether the query result is complete.	Complete
count	integer	The number of log rows returned by this query request.	1
truncation	object
truncated	boolean
truncatedColumnIndexes	array
	array
	integer
columns	array	The result column information.
	string	The result column.	column1
columnTypes	array	The result column types.
	string	The column type.	double
rows	array	The result rows.
	array	The result rows.
	any	A column in the result row.	1.2

Examples

Success response

JSON format

{
  "requestId": "EB27D183-8F6C-5C5A-A6A3-E0508AF54F78",
  "meta": {
    "affectedRows": 100,
    "elapsedMillisecond": 15,
    "progress": "Complete",
    "count": 1,
    "truncation": {
      "truncated": false,
      "truncatedColumnIndexes": [
        [
          0
        ]
      ]
    }
  },
  "columns": [
    "column1"
  ],
  "columnTypes": [
    "double"
  ],
  "rows": [
    [
      "1.2"
    ]
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.