更新时间:2026-04-15 GMT+08:00
分享

列出所有网关 - ListCoreGateways

功能介绍

检索所有网关的列表,支持可选的过滤和分页功能。

URI

GET /v1/core/gateways

表1 Query参数

参数

是否必选

参数类型

描述

name

String

参数解释:

按名称过滤网关,支持模糊匹配。

约束范围:

不涉及。

取值范围:

长度为 2-40 个字符。

默认取值:

不涉及。

status

String

参数解释:

按状态过滤网关。

约束范围:

不涉及。

取值范围:

  • active: 运行中

  • inactive: 已停用

  • creating: 创建中

  • deleting: 删除中

  • updating: 更新中

  • failed: 创建或运行失败

默认取值:

不涉及。

gateway_id

String

参数解释:

按网关ID过滤,支持多个ID(最多支持20个ID)。

示例: gateway_id=id1&gateway_id=id2

约束范围:

不涉及。

取值范围:

匹配标准的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}$。

默认取值:

不涉及。

tags

String

参数解释:

按标签过滤网关,支持多个标签,使用逗号分隔。

示例: gateway_id=id1&gateway_id=id2

约束范围:

  • 格式: key=value,多个标签用逗号分隔(需要对 =, 进行 URL 编码)

  • 匹配逻辑: AND(所有标签都必须匹配)

  • 原始示例: tags=Environment=production,Team=ai-platform

  • URL编码示例: tags=Environment%3Dproduction%2CTeam%3Dai-platform

取值范围:

  • 键:支持大小写字母、数字、连字符、下划线和中文字符,最大长度36

  • 值:支持大小写字母、数字、连字符、下划线和中文字符,最大长度43

默认取值:

不涉及。

limit

Integer

参数解释:

返回的最大结果数。

约束范围:

不涉及。

取值范围:

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

默认取值:

50

offset

Integer

参数解释:

返回结果偏移量。

约束范围:

不涉及。

取值范围:

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

默认取值:

0

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

gateways

Array of CoreGatewaySummary objects

参数解释:

网关列表。

取值范围:

数组长度为 0-100。

size

Integer

参数解释:

当前页返回的网关数量。

取值范围:

取值 0-100。

total

Integer

参数解释:

网关总数。

取值范围:

取值 0-1000000。

表3 CoreGatewaySummary

参数

参数类型

描述

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}$。

name

String

参数解释:

网关名称。

取值范围:

长度为 2-40 个字符,匹配以小写字母开头、以小写字母或数字结尾、中间可包含0到38个小写字母、数字或连字符的字符串,符合正则条件^[a-z][a-z0-9-]{0,38}[a-z0-9]$。

status

String

参数解释:

网关的当前状态。

取值范围:

  • active: 运行中

  • inactive: 已停用

  • creating: 创建中

  • deleting: 删除中

  • updating: 更新中

  • failed: 创建或运行失败

protocol_type

String

参数解释:

网关协议类型。

取值范围:

  • mcp: 模型上下文协议(Model Context Protocol)

authorizer_type

String

参数解释:

授权器类型。

取值范围:

  • custom_jwt: 使用自定义 JWT 认证(必须携带 authorizer_configuration)

  • iam: 使用 IAM 认证

  • api_key: 使用 API 密钥认证(必须携带 authorizer_configuration)

agency_name

String

参数解释:

委托名称,用于指定网关使用的委托身份。

取值范围:

长度为 1-64 个字符。

tags

Array of CoreGatewayTag objects

参数解释:

资源标签列表。

取值范围:

数组长度为 0-20。

  • 键:支持大小写字母、数字、连字符、下划线和中文字符,最大长度 36,不允许为空。

  • 值:支持大小写字母、数字、连字符、下划线和中文字符,最大长度 43,可以为空。

created_at

String

参数解释:

网关创建时间戳。

取值范围:

不涉及。

updated_at

String

参数解释:

网关最后更新时间戳。

取值范围:

不涉及。

表4 CoreGatewayTag

参数

参数类型

描述

key

String

参数解释:

标签键。

约束范围:

不涉及。

取值范围:

长度为 1-36 个字符,支持大小写字母、数字、连字符、下划线和中文字符。

默认取值:

不涉及。

value

String

参数解释:

标签值。

约束范围:

不涉及。

取值范围:

长度为 0-43 个字符,支持大小写字母、数字、连字符、下划线和中文字符,可以为空。

默认取值:

不涉及。

状态码: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]+$。

状态码:500

表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]+$。

请求示例

响应示例

状态码:200

成功检索网关列表

{
  "gateways" : [ {
    "gateway_id" : "0eaf6464-03f8-43db-b265-c37febdcadee",
    "name" : "my-gateway",
    "status" : "active",
    "protocol_type" : "mcp",
    "authorizer_type" : "custom_jwt",
    "agency_name" : "my-agency",
    "tags" : [ {
      "key" : "Environment",
      "value" : "production"
    } ],
    "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" : "请求参数不正确"
}

状态码:500

内部服务器错误

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

状态码

状态码

描述

200

成功检索网关列表

400

无效的请求参数

500

内部服务器错误

错误码

请参见错误码

相关文档