更新指定 DataAgent 的配置,包括顯示名稱、描述、系統提示詞、所扮演的 RAM 角色以及關聯的上下文模型。
介面說明
整體覆蓋,不是部分更新
請求主體中未給出的可選欄位會被重設為空值,而不是保留原值。例如只想修改 description 時,仍需把 displayName 與 systemPrompt 的原值一併提交,否則它們會被清空。
建議先呼叫 GetDataAgent 取回當前設定,在它的基礎上修改後整體提交。
必填項
contextModels 與 roleArn 為必填,缺失時返回 400;contextModels 至少需要關聯一個上下文模型。
名稱不可修改
路徑上的 name 只用於定位資源,名稱本身不可修改;如需更換名稱,請刪除後重新建立。
角色傳遞權限
使用 RAM 使用者或以扮演角色方式呼叫時,呼叫者必須擁有 roleArn 所指角色的 ram:PassRole 權限,否則返回 401。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求文法
PUT /dataagents/{name} HTTP/1.1
路徑參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| name |
string |
否 |
DataAgent 的名稱,透過請求路徑傳入,用於定位要更新的那個 DataAgent。名稱本身不可修改。 |
order-analysis-agent |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| body |
object |
是 |
請求體,JSON 格式。本介面為整體覆蓋:請求體中未給出的可選欄位會被重置為空值,而不是保留原值。 |
|
| contextModels |
array |
是 |
該 DataAgent 關聯的上下文模型名稱清單,為必填項,至少關聯一個。更新為整體覆蓋:本次提交的清單即為更新後的全部關聯關係。 |
|
|
string |
否 |
單個上下文模型的名稱,須是當前帳號下已建立的上下文模型。 |
order-context |
|
| description |
string |
否 |
DataAgent 的描述,用於說明它的職責範圍與適用場景,僅供展示與檢索,不影響執行行為;不傳或傳空字串表示清空。清單介面的 keyword 會與該描述做模糊比對。 |
負責分析訂單與收入相關日誌,並按日輸出彙總報表 |
| displayName |
string |
否 |
顯示名稱,長度上限 256 個字元(按字元數計),可含中文。本介面為整體覆蓋:不傳該欄位等同於傳空字串,會把已有的顯示名稱清空,如需保留請連同原值一起提交。 |
訂單分析助手 |
| roleArn |
string |
是 |
DataAgent 扮演並用於存取您帳號下資源的 RAM 角色 ARN,形如 acs:ram::<阿里雲帳號 UID>:role/<角色名稱>,為必填項。使用 RAM 使用者或扮演角色呼叫時,呼叫者還必須擁有該角色的 ram:PassRole 權限,否則返回 401。 |
acs:ram::123456789012****:role/sls-dataagent-role |
| systemPrompt |
string |
否 |
DataAgent 的系統提示詞,用於設定它的角色定位、能力邊界與回答風格;不傳或傳空字串表示清空。 |
您是訂單域的資料分析助手,只回答與訂單、收入相關的問題,不確定時說明原因而不是猜測 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
回應體。返回更新後的 DataAgent 配置,欄位與請求體一致。 |
||
| contextModels |
array |
更新後該 DataAgent 關聯的上下文模型名稱清單。 |
|
|
string |
單個上下文模型的名稱。 |
order-context |
|
| createdAt |
string |
建立時間,UTC 時區的 ISO8601 格式,精確到秒。 |
2026-08-14T10:00:03Z |
| description |
string |
更新後的 DataAgent 描述。未設定時返回空字串。 |
負責分析訂單與收入相關日誌,並按日輸出彙總報表 |
| displayName |
string |
更新後的顯示名稱。未設定時返回空字串 ""(不會回填成 name),展示時請按 displayName || name 回退。 |
訂單分析助手 |
| name |
string |
DataAgent 的名稱,與請求路徑中傳入的名稱一致。 |
order-analysis-agent |
| roleArn |
string |
更新後 DataAgent 扮演的 RAM 角色 ARN,形如 acs:ram::123456789012****:role/<角色名稱>。 |
acs:ram::123456789012****:role/sls-dataagent-role |
| systemPrompt |
string |
更新後的系統提示詞。未設定時返回空字串。 |
您是訂單域的資料分析助手,只回答與訂單、收入相關的問題,不確定時說明原因而不是猜測 |
| updatedAt |
string |
本次更新生效的時間,格式同 createdAt。 |
2026-08-14T11:20:35Z |
| userId |
string |
該 DataAgent 歸屬的阿里雲帳號 ID。 |
123456789012**** |
樣本
正常返回樣本
JSON格式
{
"contextModels": [
"order-context"
],
"createdAt": "2026-08-14T10:00:03Z",
"description": "负责分析订单与收入相关日志,并按日输出汇总报表",
"displayName": "订单分析助手",
"name": "order-analysis-agent",
"roleArn": "acs:ram::123456789012****:role/sls-dataagent-role",
"systemPrompt": "你是订单域的数据分析助手,只回答与订单、收入相关的问题,不确定时说明原因而不是猜测",
"updatedAt": "2026-08-14T11:20:35Z",
"userId": "123456789012****"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。