CreateCustomAgent - 建立自訂Agent - Data Management

在個人空間、工作空間中建立自訂Agent

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dms:CreateCustomAgent

create

*全部資源

*

無

請求文法

POST  HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
WorkspaceId	string	否	工作空間 ID	56kv1pvl9uvt9**********bb
Name	string	否	自訂 Agent 名稱	Agent測試名稱
Description	string	否	自訂 Agent 描述	Agent測試描述
DataJson	string	否	指定的資料範圍，JSON 字串格式通用參數說明 tableFlag：true 為指定資料範圍 scope：personal 為固定值 personal：檔案、資料庫類型的傳參檔案類型，按如下格式傳參： DataSourceType：remote_data_center 為固定值 FileId：檔案 ID Database：ListDataCenterTable 介面返回的庫名，通常為檔案名稱 Tables：ListDataCenterTable 介面返回的表名 TableIds：ListDataCenterTable 介面返回的 TableId RegionId：當前地區 `{ "tableFlag": true, "scope": "personal", "personal": { "DataSourceType": "remote_data_center", "FileId": "f-f0jksn001ibmkoo******6v2zn6", "Database": "diamonds.csv", "Tables": [ "diamonds" ], "TableIds": [ "35hfn94pxl****50pi" ], "RegionId": "cn-hangzhou" } }` 資料庫類型，按如下參數傳參： DataSourceType：database 為固定值 DmsInstanceId：資料中心介面返回的 DMS 執行個體 ID DmsDatabaseId：資料中心介面返回的 DMS 資料庫 ID FileId：執行個體名（已廢棄） DbName：資料中心介面返回的資料庫名稱 Database：資料中心介面返回的資料庫名稱 Tables：資料中心介面返回的表名 TableIds：資料中心介面返回的 TableId Engine：引擎類型（mysql、postgresql） RegionId：當前地區 `{ "tableFlag": true, "scope": "personal", "personal": { "DataSourceType": "database", "DmsInstanceId": "2848", "DmsDatabaseId": "76945", "FileId": "pgm-bp15095e***6t", "DbName": "pg_catalog", "Database": "pg_catalog", "Tables": [ "pg_aggregate" ], "TableIds": [ "5263**31" ], "Engine": "postgresql", "RegionId": "cn-hangzhou" } }`	{ "tableFlag" : true, "scope" : "personal", "personal" : { "DataSourceType" : "remote_data_center", "FileId" : "f-5qlrwaw10******s3gpw1z", "Database" : "測試表格**.xlsx", "Tables" : [ "Sheet1" ], "TableIds" : [ "****" ], "RegionId" : "cn-hangzhou" } }
Instruction	string	否	指示輸入限制：最大 10000 字元	核心指標定義： 1、GMV（成交總額）指訂單金額總和，含已支付及未支付成功訂單； 2、訂單量為每日有效下單筆數； 3、UV（獨立訪客）指訪問網站或APP的去重使用者數； 4、轉化率=支付訂單數 / UV，反映流量轉化效率；
Knowledge	string	否	知識輸入限制：最大 10000 字元	核心指標定義： 1、GMV（成交總額）指訂單金額總和，含已支付及未支付成功訂單； 2、訂單量為每日有效下單筆數； 3、UV（獨立訪客）指訪問網站或APP的去重使用者數； 4、轉化率=支付訂單數 / UV，反映流量轉化效率；
KnowledgeConfigList	array<object>	否	外部知識庫
	object	否	外部知識庫結構
AccessType	string	否	接入類型。 mcp：MCP 方式接入枚舉值： mcp : MCP 方式接入	mcp
McpServerId	string	否	MCP Server 的 Id	nhdpt9adf6ac**********ca
ExecutionConfig	object	否	執行配置
SkipPlan	boolean	否	是否跳過計劃確認步驟	true
SkipSqlConfirm	boolean	否	是否跳過所有 SQL 確認	true
SkipWebReportConfirm	boolean	否	是否跳過繪製網頁報告確認	true
SkipAskHuman	boolean	否	是否禁止過程中使用者詢問	true
ScheduleTaskConfig	object	否	周期運行任務配置
RelatedSessionId	string	否	參考的歷史會話 id	4m24*****mg7j2v
CronExpression	string	否	時間周期調度的 Cron 運算式	0 0 0 ? * 1-7
Query	string	否	周期任務的問題	分析一下這份資料，給出簡報
TextReportConfig	string	否	文字報告格式	文字報告要求所有數字不使用阿拉伯數字，全部轉為中文數字
WebReportConfig	string	否	網頁報告格式	網頁報告要求所有數字不使用阿拉伯數字，全部轉為中文數字
DMSUnit	string	否	當前 DMS 單元	cn-hangzhou
CallbackConfig	object	否
Type	string	否
ToolId	string	否
CallbackPrompt	string	否
CallbackArgs	string	否
CallbackTime	integer	否

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	Id of the request	67E910F2-4B62-5B0C-ACA3-7547695C****
Success	boolean	請求是否成功，傳回值如下： True：請求成功。 False：請求失敗。	true
ErrorCode	string	錯誤碼	success
ErrorMessage	string	調用失敗時，返回的錯誤資訊	Specified parameter Tid is not valid.
Data	object	返回結構體
CustomAgentId	string	自訂 Agent Id	ca-4y3ca4khkcu**********ysf
Name	string	自訂 Agent 名稱	Agent測試名稱
Description	string	自訂 Agent 描述	Agent測試描述
DataJson	string	指定的資料範圍，JSON 字串格式	{ "tableFlag" : true, "scope" : "personal", "personal" : { "DataSourceType" : "remote_data_center", "FileId" : "f-5qlrwaw10******s3gpw1z", "Database" : "測試表格**.xlsx", "Tables" : [ "Sheet1" ], "TableIds" : [ "****" ], "RegionId" : "cn-hangzhou" } }
Instruction	string	指示	分析架構： 1、需按日、周、月維度監控核心指標（GMV、訂單量、UV、轉化率），分析趨勢變化及同比/環比波動； 2、劃分新老客、渠道、地區進行拆解，識別增長來源與短板； 3、結合使用者行為路徑（瀏覽→加購→支付）開展漏鬥分析，定位流失環節；
Knowledge	string	知識	核心指標定義： 1、GMV（成交總額）指訂單金額總和，含已支付及未支付成功訂單； 2、訂單量為每日有效下單筆數； 3、UV（獨立訪客）指訪問網站或APP的去重使用者數； 4、轉化率=支付訂單數 / UV，反映流量轉化效率；
Status	string	自訂 Agent 狀態枚舉值： NEW : 建立-未發布 RELEASED : 發行 DRAFT : 草稿-未發布 OFFLINE : 已下線	NEW
ReleaseTime	string	發布時間	2025-12-11T14:04:32.000+00:00
OfflineTime	string	下線時間	2025-12-11T14:04:32.000+00:00
Modifier	string	修改人	20372822********
WorkspaceId	string	工作空間 ID	20923*****7291
Region	string	地區	cn-hangzhou
AliyunUid	string	阿里雲賬戶 ID	20372822********
AliyunParentUid	string	阿里雲主帳號 ID	16738266********
DmsUnit	string	當前 DMS 單元	cn-hangzhou
GmtCreated	string	建立時間	2025-12-11T14:04:32.000+00:00
GmtModified	string	修改時間	2025-12-11T14:04:32.000+00:00
KnowledgeConfigList	array<object>	外部知識庫
	object	外部知識庫結構
AccessType	string	接入類型。 mcp：MCP 方式接入枚舉值： mcp : MCP 方式接入	mcp
McpServerId	string	MCP Server 的 Id	nhdpt9adf6ac**********ca
ExecutionConfig	object	執行配置
SkipPlan	boolean	是否跳過計劃確認步驟	true
SkipSqlConfirm	boolean	是否跳過所有 SQL 確認	true
SkipWebReportConfirm	boolean	是否跳過繪製網頁報告確認	true
SkipAskHuman	boolean	是否禁止過程中使用者詢問	true
TextReportConfig	string	文字報告格式	文字報告要求所有數字不使用阿拉伯數字，全部轉為中文數字
WebReportConfig	string	網頁報告格式	網頁報告要求所有數字不使用阿拉伯數字，全部轉為中文數字
CreatorUserName	string	建立者名稱	HaoY*****
ModifierUserName	string	修改者名稱	HaoY*****
DMSUnit	string	當前 DMS 單元	cn-hangzhou
IsScheduleTask	boolean	是否配置周期運行任務	false
NextRuntime	integer	周期任務下次已耗用時間時間戳記格式	1767715200
ScheduleTaskConfig	object	周期任務配置
RelatedSessionId	string	參考的歷史會話 id	4m24*****mg7j2v
CronExpression	string	時間周期調度的 Cron 運算式	0 0 0 ? * 1-7
Query	string	周期任務的問題	分析一下這份資料，給出簡報
CallbackConfig	object
Type	string
ToolId	string
CallbackPrompt	string
CallbackArgs	string
CallbackTime	integer

樣本

正常返回樣本

JSON格式

{
  "RequestId": "67E910F2-4B62-5B0C-ACA3-7547695C****",
  "Success": true,
  "ErrorCode": "success",
  "ErrorMessage": "Specified parameter Tid is not valid.",
  "Data": {
    "CustomAgentId": "ca-4y3ca4khkcu**********ysf",
    "Name": "Agent測試名稱",
    "Description": "Agent測試描述",
    "DataJson": "{\n  \"tableFlag\" : true,\n  \"scope\" : \"personal\",\n  \"personal\" : {\n    \"DataSourceType\" : \"remote_data_center\",\n    \"FileId\" : \"f-5qlrwaw10********s3gpw1z\",\n    \"Database\" : \"測試表格******.xlsx\",\n    \"Tables\" : [ \"Sheet1\" ],\n    \"TableIds\" : [ \"******\" ],\n    \"RegionId\" : \"cn-hangzhou\"\n  }\n}",
    "Instruction": "分析架構：\n1、需按日、周、月維度監控核心指標（GMV、訂單量、UV、轉化率），分析趨勢變化及同比/環比波動；\n2、劃分新老客、渠道、地區進行拆解，識別增長來源與短板；\n3、結合使用者行為路徑（瀏覽→加購→支付）開展漏鬥分析，定位流失環節；",
    "Knowledge": "核心指標定義：\n1、GMV（成交總額）指訂單金額總和，含已支付及未支付成功訂單；\n2、訂單量為每日有效下單筆數；\n3、UV（獨立訪客）指訪問網站或APP的去重使用者數；\n4、轉化率=支付訂單數 / UV，反映流量轉化效率；",
    "Status": "NEW",
    "ReleaseTime": "2025-12-11T14:04:32.000+00:00",
    "OfflineTime": "2025-12-11T14:04:32.000+00:00",
    "Modifier": "20372822********",
    "WorkspaceId": "20923*****7291",
    "Region": "cn-hangzhou",
    "AliyunUid": "20372822********",
    "AliyunParentUid": "16738266********",
    "DmsUnit": "cn-hangzhou",
    "GmtCreated": "2025-12-11T14:04:32.000+00:00",
    "GmtModified": "2025-12-11T14:04:32.000+00:00",
    "KnowledgeConfigList": [
      {
        "AccessType": "mcp",
        "McpServerId": "nhdpt9adf6ac**********ca"
      }
    ],
    "ExecutionConfig": {
      "SkipPlan": true,
      "SkipSqlConfirm": true,
      "SkipWebReportConfirm": true,
      "SkipAskHuman": true
    },
    "TextReportConfig": "文字報告要求所有數字不使用阿拉伯數字，全部轉為中文數字",
    "WebReportConfig": "網頁報告要求所有數字不使用阿拉伯數字，全部轉為中文數字",
    "CreatorUserName": "HaoY*****",
    "ModifierUserName": "HaoY*****",
    "DMSUnit": "cn-hangzhou",
    "IsScheduleTask": false,
    "NextRuntime": 1767715200,
    "ScheduleTaskConfig": {
      "RelatedSessionId": "4m24*****mg7j2v",
      "CronExpression": "0 0 0 ? * 1-7",
      "Query": "分析一下這份資料，給出簡報"
    },
    "CallbackConfig": {
      "Type": "",
      "ToolId": "",
      "CallbackPrompt": "",
      "CallbackArgs": "",
      "CallbackTime": 0
    }
  }
}

錯誤碼

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

變更歷史

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