ListDataAgentMcp - 查询 Data Agent MCP 服务列表

更新时间:
复制 MD 格式

分页查询指定工作空间中的 MCP Server,可按名称、就绪状态和服务类型筛选。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

WorkspaceId

string

Data Agent 工作空间 ID。调用者至少需要该工作空间的 MEMBER 权限。

atvx***xmz

SearchKey

string

名称搜索关键字。服务端按 MCP Server 名称进行模糊匹配。

analytics

PageNumber

integer

页码,从 1 开始,默认值为 1。

1

PageSize

integer

每页记录数,取值范围为 1~500,默认值为 20。

20

ReadyOnly

boolean

是否仅返回已启用且状态为 ready 的 MCP Server。默认值为 false。

MaxResults

integer

兼容分页参数。当前服务端实际每页条数由 PageSize 控制。

20

NextToken

string

兼容续页标记。当前服务端实际页序由 PageNumber 控制。

page-2

Type

string

MCP Server 类型。取值:system 表示系统 MCP;customer 表示自定义 MCP。

customer

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID,用于定位本次调用。

550e***544

Success

boolean

请求处理是否成功。取值为 true 表示成功,取值为 false 表示失败。

ErrorCode

string

返回码。请求成功时为 success;请求失败时为对应的错误码。

success

ErrorMessage

string

系统级请求失败时返回的错误信息。

Failed to list MCP servers

NextToken

string

下一页标记;无更多结果时为空。

page-2

MaxResults

integer

本次响应对应的最大返回条数。

20

Data

object

MCP Server 分页查询结果。

PageSize

number

当前每页记录数。

20

PageNumber

number

当前页码,从 1 开始。

1

Content

any

当前页的 MCP Server 列表;每项包含服务标识、名称、工作空间、网络、连接方式、状态和启用状态等信息。

[{"uuid":"44lg***z65","name":"analytics","workspaceUuid":" atvx***xmz","netType":"public","transportType":"sse","state":"ready","enable":true}]

TotalElements

number

符合筛选条件的记录总数。

1

TotalPages

number

符合筛选条件的总页数。

1

示例

正常返回示例

JSON格式

{
  "RequestId": "550e***544",
  "Success": true,
  "ErrorCode": "success",
  "ErrorMessage": "Failed to list MCP servers",
  "NextToken": "page-2",
  "MaxResults": 20,
  "Data": {
    "PageSize": 20,
    "PageNumber": 1,
    "Content": "[{\"uuid\":\"44lg***z65\",\"name\":\"analytics\",\"workspaceUuid\":\"\tatvx***xmz\",\"netType\":\"public\",\"transportType\":\"sse\",\"state\":\"ready\",\"enable\":true}]",
    "TotalElements": 1,
    "TotalPages": 1
  }
}

错误码

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

变更历史

更多信息,参考变更详情