GetDasAgentSSE - 調用SSE流式資料庫診斷 - 資料庫自治服務 - 阿里雲 - Database Autonomy Service

介面說明

該介面為付費介面，將依據輸出字元進行計費，請確保在使用該介面前，已充分了解 DAS Agent 產品的收費方式與價格。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

hdm:GetDasAgentSSE

get

*全部資源。

*

無

請求文法

POST /getDasAgentSSE HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
Query	string	是	問答自然語言描述。	Are there any issues or abnormalities with my instance rm-xxx?
InstanceId	string	否	已棄用參數，執行個體 ID 透過 Query 欄位傳入。	rm-xxxx
SessionId	string	否	選用，工作階段 ID，格式為 UUID 字串，若未傳入則會建立新的工作階段，上下文對話需保持同一個工作階段 ID。	123e4567-e89b-12d3-a456-xxxxxxxxxxxx
AgentId	string	否	選用，預設使用預設 Agent 提供服務，或者傳入啟用 DAS Agent 服務後產生的或主動建立的 Agent。	ag-472T0DxtmjIxxxxx

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
Id	string	SessionId，同請求參數中的 SessionId。	123e4567-e89b-12d3-a456-xxxxxxxxxxxx
Answer	string	回答內容。	rm-xxxx
Metadata	object	中繼資訊。
Code	integer	若發生異常，會回傳錯誤類型，無異常時回傳為空。	-1810001
CharCount	integer	回答的字元數量。	1403
ToolName	string	呼叫的工具命令。	SqlFilter
ToolParams	array	工具參數。
	string	字串清單。	["--instanceId", "rm-*****", "--sqlText", "select~from~das~where~name~das1"]
RequestId	string	請求 ID。	04930480-9404-50CB-8252-Axxxxxxxx
Event	string	回傳回答資訊的類型。枚舉值： summary : 回答的相關統計 [_single.resp.200.props.Event.enum. error ]錯誤資訊 [_single.resp.200.props.Event.enum.agent_message ]大型語言模型產生的回答 [responses.200.schema.properties.Event.enumValueTitles. error ]錯誤資訊 [responses.200.schema.properties.Event.enumValueTitles.agent_message ]大型語言模型產生的回答 error : 报错信息 agent_message : 大模型生成的回答	summary

樣本

正常返回樣本

JSON格式

{
  "Id": "123e4567-e89b-12d3-a456-xxxxxxxxxxxx",
  "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"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidParams	The request parameters are invalid.	請求參數錯誤。
500	Timeout	The request processing has failed due to timeout.	由於逾時請求處理失敗。
403	NoPermission	You are not authorized to do this action.	沒有權限執行該操作。
404	InstanceNotFound	Requested instance not found.	對應執行個體 ID 無法找到。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。