# 列出所有网关 - ListCoreGateways #### 功能介绍 检索所有网关的列表，支持可选的过滤和分页功能。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-agentarts/agentarts_07_0003.html)。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-agentarts/Permission.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | agentarts:gateway:listCoreGateways | List | - | - g:RequestTag/\ - g:TagKeys | - | - | #### URI GET /v1/core/gateways 表1Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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 **约束限制：** 长度固定为36字符，必须为UUID格式。 **取值范围：** 匹配标准的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}$。 **默认取值：** 不涉及。 | | tag_key_exists | 否 | Array of strings | **参数解释：** 需要匹配的包含该标签名称的资源。 **约束限制：** 支持批量查询多个标签名，最多支持10个标签。 **取值范围：** 最小数量 1，最大数量 10。 **默认取值：** 不涉及。 | | tag_key_matches | 否 | Array of strings | **参数解释：** 需要匹配的包含该标签的资源，需要和tag_value_matches条件配合使用，tag_key_matches和tag_value_matches的元素个数需要一致，且标签顺序需要完全匹配，不支持空字符串。 **约束限制：** 支持批量查询多个标签，最多支持10个标签。tag_key_matches和tag_value_matches键值对不可重复。 **取值范围：** 最小数量 1，最大数量 10。 **默认取值：** 不涉及。 | | tag_value_matches | 否 | Array of strings | **参数解释：** 需要匹配的包含该标签的资源，需要和tag_key_matches条件配合使用，tag_key_matches和tag_value_matches的元素个数需要一致，且标签顺序需要完全匹配，支持空字符串。 **约束限制：** 支持批量查询多个标签，最多支持10个标签。tag_key_matches和tag_value_matches键值对不可重复。 **取值范围：** 最小数量 1，最大数量 10。 **默认取值：** 不涉及。 | | tag_match_policy | 否 | String | **参数解释：** 标签匹配模式，仅针对tag_key_exists，tag_key_matches，tag_value_matches参数生效。 - ALL: 若请求中包含tag_key_exists参数，查询规则为资源标签需要包含tag_key_exists中的所有元素，若请求中tag_key_matches以及tag_value_matches参数存在，查询规则为资源标签需要包含所有tag_key_matches以及tag_value_matches参数中指定的key-value对应的标签。 - ANY: 若请求中包含tag_key_exists参数，查询规则为资源标签需要包含tag_key_exists中的任意一个元素，若请求中tag_key_matches以及tag_value_matches参数存在，查询规则为资源标签需要包含tag_key_matches以及tag_value_matches参数中任意一个key-value对应的标签。 - ALL - ANY 三个参数都存在时，取tag_key_exists和tag_key_matches，tag_value_matches的交集。 三个参数都存在时，取tag_key_exists和tag_key_matches，tag_value_matches的并集。 **约束限制：** 不涉及。 **取值范围：** 允许的值为： **默认取值：** ALL | | limit | 否 | Integer | **参数解释：** 返回的最大结果数。 **约束限制：** 不涉及。 **取值范围：** 整数类型，取值为1-100。 **默认取值：** 50 | | offset | 否 | Integer | **参数解释：** 返回结果偏移量。 **约束限制：** 不涉及。 **取值范围：** 整数类型，取值为0-100000。 **默认取值：** 0 | #### 请求参数 无 #### 响应参数 **状态码：200** 表2响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | gateways | Array of [CoreGatewaySummary] objects | **参数解释：** 网关列表。 **取值范围：** 数组长度为 0-100。 | | size | Integer | **参数解释：** 当前页返回的网关数量。 **取值范围：** 取值 0-100。 | | total | Integer | **参数解释：** 网关总数。 **取值范围：** 取值 0-1000000。 | 表3CoreGatewaySummary | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | **参数解释：** 网关最后更新时间戳。 **取值范围：** 不涉及。 | 表4CoreGatewayTag | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释：** 标签键。 **取值范围：** 最大长度128个unicode字符，可用 UTF-8 格式表示的字母、数字和空格，以及以下字符：_ . : / = + - @。 | | value | String | **参数解释：** 标签值。 **取值范围：** 最大长度255个unicode字符，可用 UTF-8 格式表示的字母、数字和空格，以及以下字符：_ . : / = + - @。 | **状态码：400** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 取值为1-32个字符。 | | 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\]+$。 | **状态码：401** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 取值为1-32个字符。 | | 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\]+$。 | **状态码：403** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 取值为1-32个字符。 | | 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\]+$。 | | encoded_authorization_message | String | **参数解释：** 编码后的授权失败信息，可通过统一身份认证服务IAM的解密鉴权失败的原因接口解码获取详细授权失败原因。 **取值范围：** 取值为 1-4096 个字符。 | | details | Array of [CoreGatewayCommonError] objects | **参数解释：** 依赖的下游服务错误信息列表。 **取值范围：** 数组长度为 0-10。 | 表8CoreGatewayCommonError | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 取值为1-32个字符。 | | 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\]+$。 | **状态码：429** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 取值为1-32个字符。 | | 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** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 取值为1-32个字符。 | | 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\]+$。 | #### 请求示例 - 根据标签名是否存在进行查询 ``` GET https://{Endpoint}/v1/core/gateways?tag_key_exists=tag1&tag_key_exists=tag2 ``` - 根据标签名和标签值进行查询 ``` GET https://{Endpoint}/v1/core/gateways?tag_key_matches=tag1&tag_value_matches=tag1_value&tag_key_matches=tag2&tag_value_matches=tag2_value ``` #### 响应示例 **状态码：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.02000001", "error_msg" : "请求参数错误", "error_reason" : "请求参数错误", "error_suggestion" : "根据接口返回的具体原因修改请求参数" } ``` **状态码：401** 认证信息无法识别 ``` { "error_code" : "AgentArts.02000300", "error_msg" : "认证信息无法识别", "error_reason" : "认证信息无法识别", "error_suggestion" : "使用正确的认证信息访问" } ``` **状态码：403** 权限不足，拒绝访问 ``` { "error_code" : "AgentArts.02000200", "error_msg" : "没有权限执行该操作", "error_reason" : "没有权限执行该操作", "error_suggestion" : "请检查权限是否配置正确", "encoded_authorization_message" : "eyJlcnJvciI6ICJVbmF1dGhvcml6ZWQifQ==", "details" : [ { "error_code" : "IAM.0082", "error_msg" : "权限不足，拒绝访问" } ] } ``` **状态码：429** 请求频率超限。 ``` { "error_code" : "AgentArts.02000400", "error_msg" : "请求过于频繁，请稍后重试", "error_reason" : "请求过于频繁，请稍后重试", "error_suggestion" : "稍后重试" } ``` **状态码：500** 内部服务器错误 ``` { "error_code" : "AgentArts.02000500", "error_msg" : "服务连接超时", "error_reason" : "服务连接超时", "error_suggestion" : "请稍后重试" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 成功检索网关列表 | | 400 | 请求参数错误 | | 401 | 认证信息无法识别 | | 403 | 权限不足，拒绝访问 | | 429 | 请求频率超限。 | | 500 | 内部服务器错误 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-agentarts/ErrorCode.html)。