文档首页/ 智能体开发平台 AgentArts/ API参考/ API/ 网关/ 网关后端管理/ 列出目标服务 - ListCoreGatewayTargets
更新时间:2026-04-15 GMT+08:00
分享

列出目标服务 - ListCoreGatewayTargets

功能介绍

列出指定网关的所有目标服务,支持分页功能。

URI

GET /v1/core/gateways/{gateway_id}/targets

表1 路径参数

参数

是否必选

参数类型

描述

gateway_id

String

参数解释:

网关的唯一标识符。

网关ID获取方式:

  1. 进入AgentArts平台,在左侧导航栏选择“开发中心 > 组件库 ”,选择“网关”页签。

  2. 在网关列表中“网关名称/ID”处复制网关ID即可。

约束范围:

不涉及。

取值范围:

匹配标准的UUID格式(8-4-4-4-12的十六进制数字串,由连字符分隔),符合正则条件^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

参数解释:

返回的最大结果数。

约束范围:

不涉及。

取值范围:

整数类型,取值为1-100。

默认取值:

50

offset

Integer

参数解释:

返回结果偏移量。

约束范围:

不涉及。

取值范围:

整数类型,取值为1-100000。

默认取值:

0

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

targets

Array of CoreGatewayTargetSummary objects

参数解释:

目标服务列表。

取值范围:

数组长度为 0-100。

size

Integer

参数解释:

当前页返回的目标服务数量。

取值范围:

取值为 0-100。

total

Integer

参数解释:

目标服务总数。

取值范围:

取值为 0-1000000。

表4 CoreGatewayTargetSummary

参数

参数类型

描述

target_id

String

参数解释:

目标服务的唯一标识符。

取值范围:

匹配标准的UUID格式(8-4-4-4-12的十六进制数字串,由连字符分隔),符合正则条件^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$。

gateway_id

String

参数解释:

所属网关的标识符。

取值范围:

匹配标准的UUID格式(8-4-4-4-12的十六进制数字串,由连字符分隔),符合正则条件^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$。

name

String

参数解释:

目标服务名称。

取值范围:

长度为 1-50 个字符,匹配以字母数字开头和结尾、中间可含0到48个字母数字或短横线的字符串,符合正则条件^[a-zA-Z0-9]([a-zA-Z0-9-]{0,48}[a-zA-Z0-9])?$。

status

String

参数解释:

目标服务状态。

取值范围:

  • creating: 创建中

  • updating: 更新中

  • ready: 就绪可用

  • failed: 失败

  • deleting: 删除中

target_type

String

参数解释:

目标服务类型。

取值范围:

  • mcp_server: MCP 服务器

  • openapi: 基于 OpenAPI 规范的 REST API

created_at

String

参数解释:

创建时间。

取值范围:

不涉及。

updated_at

String

参数解释:

更新时间。

取值范围:

不涉及。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

取值为固定18个字符,匹配以 AgentArts. 开头、后接恰好8位数字的字符串,符合正则条件^AgentArts.[0-9]{8}$。

error_msg

String

参数解释:

错误消息。

取值范围:

取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()'"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。

error_reason

String

参数解释:

错误原因。

取值范围:

取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()'"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。

error_suggestion

String

参数解释:

错误处理建议。

取值范围:

取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()'"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。

状态码:404

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

取值为固定18个字符,匹配以 AgentArts. 开头、后接恰好8位数字的字符串,符合正则条件^AgentArts.[0-9]{8}$。

error_msg

String

参数解释:

错误消息。

取值范围:

取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()'"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。

error_reason

String

参数解释:

错误原因。

取值范围:

取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()'"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。

error_suggestion

String

参数解释:

错误处理建议。

取值范围:

取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()'"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。

状态码:500

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

取值为固定18个字符,匹配以 AgentArts. 开头、后接恰好8位数字的字符串,符合正则条件^AgentArts.[0-9]{8}$。

error_msg

String

参数解释:

错误消息。

取值范围:

取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()'"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。

error_reason

String

参数解释:

错误原因。

取值范围:

取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()'"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。

error_suggestion

String

参数解释:

错误处理建议。

取值范围:

取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()'"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。

请求示例

响应示例

状态码:200

成功检索目标服务列表

{
  "targets" : [ {
    "target_id" : "25497155-11d8-44ca-be20-8ab1904a4107",
    "gateway_id" : "b2fc0463-8b28-46c5-87ba-6267295ffc57",
    "name" : "my-target",
    "status" : "ready",
    "target_type" : "mcp_server",
    "created_at" : "2024-01-15T10:30:00Z",
    "updated_at" : "2024-01-15T10:30:00Z"
  } ],
  "size" : 1,
  "total" : 1
}

状态码:400

无效的请求参数

{
  "error_code" : "AgentArts.02000002",
  "error_msg" : "请求参数不正确"
}

状态码:404

网关未找到

{
  "error_code" : "AgentArts.02000102",
  "error_msg" : "网关未找到"
}

状态码:500

内部服务器错误

{
  "error_code" : "AgentArts.02000500",
  "error_msg" : "内部服务器错误"
}

状态码

状态码

描述

200

成功检索目标服务列表

400

无效的请求参数

404

网关未找到

500

内部服务器错误

错误码

请参见错误码

相关文档