AI 助理
文档备案控制台
官方文档
首页 数据管理 DMS 开发参考 API参考-DMS（2025-04-14） API目录 其他 DescribeCustomAgent - 获取自定义Agent详细描述

DescribeCustomAgent - 获取自定义Agent详细描述

更新时间：
复制 MD 格式
产品详情
我的收藏

DescribeCustomAgent 根据自定义Agent ID获取详情描述信息

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dms:DescribeCustomAgent

get

*全部资源

*

 无 无

请求语法

POST  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值
WorkspaceId

string

否

工作空间 ID。

56kv1pvl9uvt9**********bb
CustomAgentId

string

否

自定义 Agent Id。

ca-4y3ca4khkcu**********ysf

返回参数

名称

类型

描述

示例值

object

Schema of Response

Data

object

返回结构体

AgentType

string

自定义 Agent 类型

  • Default：系统内置自定义 Agent

  • Common：普通自定义 Agent

Common
AliyunParentUid

string

阿里云主账号 ID

16738266********
AliyunUid

string

阿里云账户 ID

20372822********
CallbackConfig

object

回调功能配置项

CallbackArgs

string

回调工具调用参数

{"ID":"test"}
CallbackPrompt

string

回调工具调用参数生成 prompt

send web report to 123456@163.com
CallbackTime

integer

回调工具调用时机

0
ToolId

string

回调工具标志符

Mcp serverId (6te...g7a)

Type

string

回调工具类型

Mcp
CreatorUserName

string

创建者名称

HaoY*****
CustomAgentId

string

自定义 Agent Id

ca-4y3ca4khkcu**********ysf
DMSUnit

string

当前 DMS 单元

cn-hangzhou
DataJson

string

指定的数据范围，JSON 字符串格式

{ "tableFlag" : true, "scope" : "personal", "personal" : { "DataSourceType" : "remote_data_center", "FileId" : "f-5qlrwaw10********s3gpw1z", "Database" : "test-table******.xlsx", "Tables" : [ "Sheet1" ], "TableIds" : [ "******" ], "RegionId" : "cn-hangzhou" } }
DefaultAgent

integer

是否为默认显示的 Agent

1
Description

string

自定义 Agent 描述

Description for the test agent
DmsUnit

string

当前 DMS 单元

cn-hangzhou
ExecutionConfig

object

执行配置

ForbiddenAppendDataSource

boolean

是否禁止会话中追加数据源

true
SkipAskHuman

boolean

是否禁止过程中用户询问

false
SkipPlan

boolean

是否跳过计划确认步骤

true
SkipSqlConfirm

boolean

是否跳过所有 SQL 确认

true
SkipWebReportConfirm

boolean

是否跳过绘制网页报告确认

false
GmtCreated

string

创建时间

2025-12-11T14:04:32.000+00:00
GmtModified

string

修改时间

2025-12-11T14:04:32.000+00:00
Instruction

string

指示

Analytical framework: Monitor core metrics (GMV, order volume, UV, and conversion rate) on a daily, weekly, and monthly basis to analyze trends and identify year-over-year and month-over-month fluctuations. Segment by new vs. returning customers, channels, and regions to identify growth drivers and areas of weakness. Conduct funnel analysis based on user behavior paths (browse → add to cart → purchase) to pinpoint stages where user drop-off occurs.
IsScheduleTask

boolean

是否配置周期运行任务

true
Knowledge

string

知识

Core metric definitions: GMV (Gross Merchandise Volume) refers to the total sum of order amounts, including both paid and unpaid orders. Order volume refers to the number of valid orders placed per day. UV (Unique Visitors) refers to the deduplicated number of users who visit the website or app. Conversion rate = paid orders / UV, reflecting the efficiency of traffic conversion.
KnowledgeConfigList

array<object>

外部知识库

object

外部知识库结构

AccessType

string

接入类型

  • mcp：MCP 方式接入

  • dms_kb：DMS 知识库方式接入

mcp
KbUuid

string

知识库 ID

kb-HZ-6anhdzx7hddf9*******obx
McpServerId

string

MCP Server 的 Id

nhdpt9adf6ac**********ca
KnowledgeSemanticConfigList

array<object>

知识语义配置列表

object

知识语义配置结构体

DbId

string

DMS 数据库 ID

71991648
InstanceId

string

DMS 实例 ID

2190779
KnowledgeUuid

string

知识 Uuid

7ca8f50d78234******e87
Type

string

知识语义类型

  • sql_template：SQL 模板

  • ossie_model：Ossie 语义视图

sql_template
Modifier

string

修改人

20372822********
ModifierUserName

string

修改者名称

HaoY*****
Name

string

自定义 Agent 名称

Test agent name
NextRuntime

integer

周期任务下次运行时间

1767715200
OfflineTime

string

下线时间

2025-12-11T14:04:32.000+00:00
RecommendQuestionList

array

推荐问题列表

  • 可配置最多 10 个推荐问题

string

推荐问题

Help me find some business insight from this data
Region

string

地域

cn-hangzhou
RelatedSessionId

string

参考历史会话 Id

5xyz...
ReleaseTime

string

发布时间

2025-12-11T14:04:32.000+00:00
ScheduleTaskConfig

object

周期任务配置

CronExpression

string

时间周期调度的 Cron 表达式

0 0 0 ? * 1-7
Query

string

周期任务的问题

Analyze the data and provide the report
RelatedSessionId

string

参考的历史会话 id

4m24*****mg7j2v
Status

string

自定义 Agent 状态

枚举值：

  • NEW :

    新建-未发布

  • RELEASED :

    已发布

  • DRAFT :

    草稿-未发布

  • OFFLINE :

    已下线

RELEASED
TextReportConfig

string

文字报告格式

The text report requires that all numbers be written in Chinese numerals rather than Arabic numerals.

UserSpecifiedSkillList

array

用户指定的技能列表

string

技能 ID

ski-sldk8v******3owd
WebReportConfig

string

网页报告格式

The web report requires that all numbers be written in Chinese numerals rather than Arabic numerals.

WebReportTheme

string

网页报告主题：

  • default：默认

  • journal：手账

  • legacy：经典

  • neobrutalism：风格化

  • infographic：信息图

default
WorkspaceId

string

工作空间 ID

56kv1pvl9uvt9**********bb
ErrorCode

string

错误码。

success
ErrorMessage

string

调用失败时，返回的错误信息

Specified parameter Tid is not valid.
RequestId

string

Id of the request

67E910F2-4B62-5B0C-ACA3-7547695C****
Success

boolean

请求是否成功，返回值如下：

  • true：请求成功。

  • false：请求失败。

true

示例

正常返回示例

JSON格式

{
  "Data": {
    "AgentType": "Common",
    "AliyunParentUid": "16738266********",
    "AliyunUid": "20372822********",
    "CallbackConfig": {
      "CallbackArgs": "{\"ID\":\"test\"}",
      "CallbackPrompt": "send web report to 123456@163.com",
      "CallbackTime": 0,
      "ToolId": "Mcp serverId (6te...g7a)\n",
      "Type": "Mcp"
    },
    "CreatorUserName": "HaoY*****",
    "CustomAgentId": "ca-4y3ca4khkcu**********ysf",
    "DMSUnit": "cn-hangzhou",
    "DataJson": "{\n  \"tableFlag\" : true,\n  \"scope\" : \"personal\",\n  \"personal\" : {\n    \"DataSourceType\" : \"remote_data_center\",\n    \"FileId\" : \"f-5qlrwaw10********s3gpw1z\",\n    \"Database\" : \"test-table******.xlsx\",\n    \"Tables\" : [ \"Sheet1\" ],\n    \"TableIds\" : [ \"******\" ],\n    \"RegionId\" : \"cn-hangzhou\"\n  }\n}",
    "DefaultAgent": 1,
    "Description": "Description for the test agent",
    "DmsUnit": "cn-hangzhou",
    "ExecutionConfig": {
      "ForbiddenAppendDataSource": true,
      "SkipAskHuman": false,
      "SkipPlan": true,
      "SkipSqlConfirm": true,
      "SkipWebReportConfirm": false
    },
    "GmtCreated": "2025-12-11T14:04:32.000+00:00",
    "GmtModified": "2025-12-11T14:04:32.000+00:00",
    "Instruction": "Analytical framework:\n\nMonitor core metrics (GMV, order volume, UV, and conversion rate) on a daily, weekly, and monthly basis to analyze trends and identify year-over-year and month-over-month fluctuations.\nSegment by new vs. returning customers, channels, and regions to identify growth drivers and areas of weakness.\nConduct funnel analysis based on user behavior paths (browse → add to cart → purchase) to pinpoint stages where user drop-off occurs.",
    "IsScheduleTask": true,
    "Knowledge": "Core metric definitions:\n\nGMV (Gross Merchandise Volume) refers to the total sum of order amounts, including both paid and unpaid orders.\nOrder volume refers to the number of valid orders placed per day.\nUV (Unique Visitors) refers to the deduplicated number of users who visit the website or app.\nConversion rate = paid orders / UV, reflecting the efficiency of traffic conversion.",
    "KnowledgeConfigList": [
      {
        "AccessType": "mcp",
        "KbUuid": "kb-HZ-6anhdzx7hddf9*******obx",
        "McpServerId": "nhdpt9adf6ac**********ca"
      }
    ],
    "KnowledgeSemanticConfigList": [
      {
        "DbId": "71991648",
        "InstanceId": "2190779",
        "KnowledgeUuid": "7ca8f50d78234******e87",
        "Type": "sql_template"
      }
    ],
    "Modifier": "20372822********",
    "ModifierUserName": "HaoY*****",
    "Name": "Test agent name",
    "NextRuntime": 1767715200,
    "OfflineTime": "2025-12-11T14:04:32.000+00:00",
    "RecommendQuestionList": [
      "Help me find some business insight from this data"
    ],
    "Region": "cn-hangzhou",
    "RelatedSessionId": "5xyz...",
    "ReleaseTime": "2025-12-11T14:04:32.000+00:00",
    "ScheduleTaskConfig": {
      "CronExpression": "0 0 0 ? * 1-7",
      "Query": "Analyze the data and provide the report",
      "RelatedSessionId": "4m24*****mg7j2v"
    },
    "Status": "RELEASED",
    "TextReportConfig": "The text report requires that all numbers be written in Chinese numerals rather than Arabic numerals.\n\n\n",
    "UserSpecifiedSkillList": [
      "ski-sldk8v******3owd"
    ],
    "WebReportConfig": "The web report requires that all numbers be written in Chinese numerals rather than Arabic numerals.\n\n\n",
    "WebReportTheme": "default",
    "WorkspaceId": "56kv1pvl9uvt9**********bb"
  },
  "ErrorCode": "success",
  "ErrorMessage": "Specified parameter Tid is not valid.",
  "RequestId": "67E910F2-4B62-5B0C-ACA3-7547695C****",
  "Success": true
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。

上一篇：DeleteWorkspaceCode - 删除工作空间的代码及目录下一篇：DescribeDataAgentMetrics - 查询DataAgent指标