GetDasAgentSSE - Database Autonomy Service - Alibaba Cloud Documentation Center

Operation description

This is a paid API. You are charged based on the number of output characters. Before you use this API, make sure that you understand the billing methods and pricing of the DAS Agent product. Java and Python call examples are provided for your reference.

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

hdm:GetDasAgentSSE

get

*All Resource

*

None

Request syntax

POST /getDasAgentSSE HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Query	string	Yes	The question in natural language.	Are there any issues or abnormalities with my instance rm-xxx?
InstanceId	string	No	This parameter is deprecated. Pass the instance ID in the Query parameter.	rm-xxxx
SessionId	string	No	The session ID in UUID string format. This parameter is optional. If you do not specify this parameter, a new session is created. To maintain conversational context, use the same session ID for all requests in the conversation.	123e4567-e89b-12d3-a456-xxxxxxxxxxxx
AgentId	string	No	The agent ID. This parameter is optional. By default, the default agent is used. You can also specify the ID of an agent that was generated after you enabled the DAS Agent service or an agent that you created.	ag-472T0DxtmjIxxxxx

Response elements

Element	Type	Description	Example
	object	Schema of Response
Id	string	The session ID. This is the same as the SessionId in the request.	xxx-xxx-xxx
Answer	string	The content of the answer.	rm-xxxx
Metadata	object	Metadata.
Code	integer	The error code. This is returned if an error occurs. If the request is successful, this parameter is empty.	-1810001
CharCount	integer	The number of characters in the answer.	1403
ToolName	string	The tool command that was called.	SqlFilter
ToolParams	array	Tool parameters.
	string	A list of strings.	["--instanceId", "rm-*****", "--sqlText", "select~from~das~where~name~das1"]
RequestId	string	The request ID.	04930480-9404-50CB-8252-Axxxxxxxx
Event	string	The type of the returned information. Valid values: summary : The statistics of the answer. error : The error message. agent_message : The answer generated by the large model.	summary

Examples

Success response

JSON format

{
  "Id": "xxx-xxx-xxx",
  "Answer": "rm-xxxx",
  "Metadata": {
    "Code": -1810001,
    "CharCount": 1403,
    "ToolName": "SqlFilter",
    "ToolParams": [
      "[\"--instanceId\", \"rm-*****\", \"--sqlText\", \"select~from~das~where~name~das1\"]"
    ],
    "RequestId": "04930480-9404-50CB-8252-Axxxxxxxx"
  },
  "Event": "summary"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The request parameters are invalid.
500	Timeout	The request processing has failed due to timeout.	Request processing failed due to timeout.
403	NoPermission	You are not authorized to do this action.
404	InstanceNotFound	Requested instance not found.	The corresponding instance ID cannot be found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.