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

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 :

    已下线

RELEASED
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

56kv1pvl9uvt9**********bb
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

McpServerId

string

ExecutionConfig

object

执行配置

SkipPlan

boolean

是否跳过计划确认步骤

true
SkipSqlConfirm

boolean

是否跳过所有 SQL 确认

true
SkipWebReportConfirm

boolean

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

false
SkipAskHuman

boolean

是否禁止过程中用户询问

false
TextReportConfig

string

文字报告格式

文字报告要求所有数字不使用阿拉伯数字，全部转为中文数字
WebReportConfig

string

网页报告格式

网页报告要求所有数字不使用阿拉伯数字，全部转为中文数字
DefaultAgent

integer

CreatorUserName

string

创建者名称

HaoY*****
ModifierUserName

string

修改者名称

HaoY*****
DMSUnit

string

cn-hangzhou
IsScheduleTask

boolean

是否配置周期运行任务

true
NextRuntime

integer

周期任务下次运行时间

1767715200
ScheduleTaskConfig

object

周期任务配置

RelatedSessionId

string

参考的历史会话 id

4m24*****mg7j2v
CronExpression

string

时间周期调度的 Cron 表达式

0 0 0 ? * 1-7
Query

string

周期任务的问题

分析一下这份数据，给出简报

示例

正常返回示例

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": "RELEASED",
    "ReleaseTime": "2025-12-11T14:04:32.000+00:00",
    "OfflineTime": "2025-12-11T14:04:32.000+00:00",
    "Modifier": "20372822********",
    "WorkspaceId": "56kv1pvl9uvt9**********bb",
    "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": "",
        "McpServerId": ""
      }
    ],
    "ExecutionConfig": {
      "SkipPlan": true,
      "SkipSqlConfirm": true,
      "SkipWebReportConfirm": false,
      "SkipAskHuman": false
    },
    "TextReportConfig": "文字报告要求所有数字不使用阿拉伯数字，全部转为中文数字",
    "WebReportConfig": "网页报告要求所有数字不使用阿拉伯数字，全部转为中文数字",
    "DefaultAgent": 0,
    "CreatorUserName": "HaoY*****",
    "ModifierUserName": "HaoY*****",
    "DMSUnit": "cn-hangzhou",
    "IsScheduleTask": true,
    "NextRuntime": 1767715200,
    "ScheduleTaskConfig": {
      "RelatedSessionId": "4m24*****mg7j2v",
      "CronExpression": "0 0 0 ? * 1-7",
      "Query": "分析一下这份数据，给出简报"
    }
  }
}

错误码

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

变更历史

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

上一篇：DeleteFileUpload - 删除上传文件下一篇：DescribeDataAgentSession - 获取DataAgent会话描述