DescribeCustomAgent-阿里云帮助中心

DescribeCustomAgent retrieves the details of a custom agent by its agent ID.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dms:DescribeCustomAgent

get

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	No	The ID of the workspace.	56kv1pvl9uvt9**********bb
CustomAgentId	string	No	The ID of the custom agent.	ca-4y3ca4khkcu**********ysf

Response elements

Element	Type	Description	Example
	object	The schema of the response.
RequestId	string	The ID of the request.	67E910F2-4B62-5B0C-ACA3-7547695C****
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
ErrorCode	string	The error code returned if the request fails.	success
ErrorMessage	string	The error message returned if the request fails.	Specified parameter Tid is not valid.
Data	object	The details of the custom agent.
CustomAgentId	string	The ID of the custom agent.	ca-4y3ca4khkcu**********ysf
Name	string	The name of the custom agent.	Agent测试名称
Description	string	The description of the custom agent.	Agent测试描述
DataJson	string	The data scope, formatted as a JSON string.	{ "tableFlag" : true, "scope" : "personal", "personal" : { "DataSourceType" : "remote_data_center", "FileId" : "f-5qlrwaw10******s3gpw1z", "Database" : "测试表格**.xlsx", "Tables" : [ "Sheet1" ], "TableIds" : [ "****" ], "RegionId" : "cn-hangzhou" } }
Instruction	string	The instruction for the agent's analysis.	分析框架： 1、需按日、周、月维度监控核心指标（GMV、订单量、UV、转化率），分析趋势变化及同比/环比波动； 2、划分新老客、渠道、地域进行拆解，识别增长来源与短板； 3、结合用户行为路径（浏览→加购→支付）开展漏斗分析，定位流失环节；
Knowledge	string	The domain knowledge for the agent.	核心指标定义： 1、GMV（成交总额）指订单金额总和，含已支付及未支付成功订单； 2、订单量为每日有效下单笔数； 3、UV（独立访客）指访问网站或APP的去重用户数； 4、转化率=支付订单数 / UV，反映流量转化效率；
Status	string	The status of the custom agent. Valid values: Valid values: NEW : A new agent that is not yet published. RELEASED : Published. DRAFT : A draft that is not yet published. OFFLINE : Taken offline.	RELEASED
ReleaseTime	string	The release time.	2025-12-11T14:04:32.000+00:00
OfflineTime	string	The time when the agent was taken offline.	2025-12-11T14:04:32.000+00:00
Modifier	string	The ID of the user who last modified the agent.	20372822********
WorkspaceId	string	The ID of the workspace.	56kv1pvl9uvt9**********bb
Region	string	The region.	cn-hangzhou
AliyunUid	string	The Alibaba Cloud account ID.	20372822********
AliyunParentUid	string	The ID of the parent Alibaba Cloud account.	16738266********
DmsUnit	string	The current DMS unit.	cn-hangzhou
GmtCreated	string	The time when the agent was created.	2025-12-11T14:04:32.000+00:00
GmtModified	string	The time when the agent was last modified.	2025-12-11T14:04:32.000+00:00
KnowledgeConfigList	array<object>	The knowledge configurations.
	object
AccessType	string	The access type.
McpServerId	string	The ID of the MCP server.
KbUuid	string	The UUID of the knowledge base.
ExecutionConfig	object	The execution configuration.
SkipPlan	boolean	Specifies whether to skip the plan confirmation step.	true
SkipSqlConfirm	boolean	Specifies whether to skip all SQL confirmations.	true
SkipWebReportConfirm	boolean	Specifies whether to skip confirmation before a web report is generated.	false
SkipAskHuman	boolean	Specifies whether to disable prompts that require human intervention.	false
TextReportConfig	string	The formatting requirements for the text report.	文字报告要求所有数字不使用阿拉伯数字，全部转为中文数字
WebReportConfig	string	The formatting requirements for the web report.	网页报告要求所有数字不使用阿拉伯数字，全部转为中文数字
DefaultAgent	integer	Indicates whether this is the default agent.
CreatorUserName	string	The username of the creator.	HaoY*****
ModifierUserName	string	The username of the modifier.	HaoY*****
DMSUnit	string	The current DMS unit.	cn-hangzhou
IsScheduleTask	boolean	Indicates whether a scheduled task is configured.	true
NextRuntime	integer	The next scheduled execution time.	1767715200
ScheduleTaskConfig	object	The configuration of the scheduled task.
RelatedSessionId	string	The ID of the related historical session.	4m24*****mg7j2v
CronExpression	string	The cron expression for the scheduled task.	0 0 0 ? * 1-7
Query	string	The task query.	分析一下这份数据，给出简报
CallbackConfig	object	The callback configuration.
Type	string	The callback type.
ToolId	string	The tool ID.
CallbackPrompt	string	The callback prompt.
CallbackArgs	string	The callback arguments.
CallbackTime	integer	The callback time.
RelatedSessionId	string	The ID of the related historical session.	5xyz...

Examples

Success response

JSON format

{
  "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": "",
        "KbUuid": ""
      }
    ],
    "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": "分析一下这份数据，给出简报"
    },
    "CallbackConfig": {
      "Type": "",
      "ToolId": "",
      "CallbackPrompt": "",
      "CallbackArgs": "",
      "CallbackTime": 0
    },
    "RelatedSessionId": "5xyz..."
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.