# 获取网关详情 - ShowCoreGateway #### 功能介绍 通过 ID 获取指定网关的详细信息。 #### 调用方法 请参见[如何调用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:showCoreGateway | Read | gateway \* | g:ResourceTag/\ | - | - | #### URI GET /v1/core/gateways/{gateway_id} 表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}$。 **默认取值：** 不涉及。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表2响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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\]$。 | | description | String | **参数解释：** 网关的详细描述。 **取值范围：** 长度为 1-1000 个字符。 | | status | String | **参数解释：** 网关的当前状态。 **取值范围：** - *active*: 运行中 - *inactive*: 已停用 - *creating*: 创建中 - *deleting*: 删除中 - *updating*: 更新中 - *failed*: 创建或运行失败 | | protocol_type | String | **参数解释：** 网关协议类型。 **取值范围：** - *mcp*: 模型上下文协议（Model Context Protocol） | | protocol_configuration | [CoreGatewayProtocolConfiguration] object | **参数解释：** 网关协议的自定义设置。 **取值范围：** 不涉及。 | | authorizer_type | String | **参数解释：** 入站认证类型，查询响应中不返回配置详情，可通过 workload_identity.urn 获取入站认证配置详情。 **取值范围：** - *custom_jwt*: 使用自定义 JWT 认证 - *iam*: 使用 IAM 认证 - *api_key*: 使用 API 密钥认证 | | agency_name | String | **参数解释：** 委托名称，用于指定网关使用的委托身份。 **取值范围：** 长度为 1-64 个字符。 | | endpoint_url | String | **参数解释：** 访问网关的 URL 端点。 **取值范围：** 长度为 1-512 个字符。 - 格式：https://\.gateway.agentarts.\.huaweicloudapis.com - 示例：https://b2fc0463-8b28-46c5-87ba-6267295ffc57.gateway.agentarts.cn-north-4.huaweicloudapis.com | | log_delivery_configuration | [CoreGatewayLogDeliveryConfiguration] object | **参数解释：** 日志上报配置。 | | workload_identity | [CoreGatewayWorkloadIdentity] object | **参数解释：** 工作负载身份标识，用于代理身份认证。 | | agent_gateway_id | String | **参数解释：** AgentGateway ID，关联底层 AgentGateway 实例。 **取值范围：** 匹配标准的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}$。 | | outbound_network_configuration | [CoreGatewayOutboundNetworkConfiguration] object | **参数解释：** 出站网络配置。 **取值范围：** 不涉及。 | | tags | Array of [CoreGatewayTag] objects | **参数解释：** 资源标签列表。 **取值范围：** 数组长度为0-20。 | | created_at | String | **参数解释：** 网关创建时间戳。 **取值范围：** 遵循ISO 8601标准格式，例如：2024-01-15T10:30:00Z。 | | updated_at | String | **参数解释：** 网关最后更新时间戳。 **取值范围：** 遵循ISO 8601标准格式，例如：2024-01-15T10:30:00Z。 | 表3CoreGatewayProtocolConfiguration | 参数 | 参数类型 | 描述 | |:---|:---|:---| | mcp | [CoreGatewayMcpProtocolConfiguration] object | **参数解释：** MCP网关配置。 **取值范围：** 不涉及。 | 表4CoreGatewayMcpProtocolConfiguration | 参数 | 参数类型 | 描述 | |:---|:---|:---| | search_configuration | [CoreGatewaySearchConfiguration] object | **参数解释：** 搜索操作配置。 **取值范围：** 不涉及。 | | supported_versions | Array of strings | **参数解释：** MCP网关支持的协议版本列表，支持选择的MCP版本：2025-03-26、2025-06-18、2025-11-25。 **取值范围：** 每个元素为YYYY-MM-DD格式的MCP协议版本号。 | | session_configuration | [CoreGatewaySessionConfiguration] object | **参数解释：** 会话管理配置。 **约束范围：** 不涉及。 **取值范围：** 不涉及。 | 表5CoreGatewaySearchConfiguration | 参数 | 参数类型 | 描述 | |:---|:---|:---| | search_type | String | **参数解释：** 搜索类型，该字段用于指定网关如何处理搜索操作。 **取值范围：** - semantic: 语义检索 | | top_n | Integer | **参数解释：** 当search_type为semantic时，该字段可选。用于指定语义检索场景返回的工具数量。 **取值范围：** 取值为1-100个。 | | score_threshold | String | **参数解释：** 当search_type为semantic时，该字段可选。语义检索场景，只有工具的相似得分不低于该值时才会返回。 **取值范围：** 取值为0\~1，满足正则表达式\^(0\|1\|0.\[0-9\]\|1.0)$。 | 表6CoreGatewaySessionConfiguration | 参数 | 参数类型 | 描述 | |:---|:---|:---| | enabled | Boolean | **参数解释：** 会话管理开关。 **约束范围：** 不涉及。 **取值范围：** true或false。 | 表7CoreGatewayLogDeliveryConfiguration | 参数 | 参数类型 | 描述 | |:---|:---|:---| | enabled | Boolean | **参数解释：** 是否启用日志。 **取值范围：** 当取值为true时，表示启用日志。当取值为false时，表示不启用日志。 | | log_group_id | String | **参数解释：** LTS日志组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}$。 | | log_stream_id | String | **参数解释：** LTS日志流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}$。 | 表8CoreGatewayWorkloadIdentity | 参数 | 参数类型 | 描述 | |:---|:---|:---| | urn | String | **参数解释：** 工作负载标识的统一资源名称，格式为''agentIdentity:\:\:workloadIdentity:gateway_\''。 **取值范围：** 长度为 1-200 个字符。 | 表9CoreGatewayOutboundNetworkConfiguration | 参数 | 参数类型 | 描述 | |:---|:---|:---| | network_mode | String | **参数解释：** 网络模式。 **取值范围：** - *public*: 使用公网访问 - *vpc*: 使用VPC网络访问（需配置vpc_config） | | vpc_config | [CoreGatewayVpcConfig] object | **参数解释：** VPC网络配置。 **取值范围：** 不涉及。 | 表10CoreGatewayVpcConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | vpc_id | String | **参数解释：** VPC ID，VPC网络的唯一标识。 VPC ID获取方式： 1. 进入虚拟私有云，在左侧导航栏选择"我的VPC"。 2. 在虚拟私有云VPC列表中"名称/ID"处复制VPC 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}$。 | | subnet_id | String | **参数解释：** 子网ID，VPC子网的唯一标识。 子网ID获取方式： 1. 进入虚拟私有云，在左侧导航栏选择"子网"。 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}$。 | | security_group_ids | Array of strings | **参数解释：** 安全组ID列表。 **取值范围：** 数组长度为0-10。 | 表11CoreGatewayTag | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释：** 标签键。 **取值范围：** 最大长度128个unicode字符，可用 UTF-8 格式表示的字母、数字和空格，以及以下字符：_ . : / = + - @。 | | value | String | **参数解释：** 标签值。 **取值范围：** 最大长度255个unicode字符，可用 UTF-8 格式表示的字母、数字和空格，以及以下字符：_ . : / = + - @。 | **状态码：404** 表12响应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** 表13响应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** 表14响应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。 | 表15CoreGatewayCommonError | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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** 表16响应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** 表17响应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\]+$。 | #### 请求示例 无 #### 响应示例 **状态码：200** 成功检索网关详情 ``` { "gateway_id" : "b2fc0463-8b28-46c5-87ba-6267295ffc57", "name" : "my-gateway", "description" : "我的 MCP 网关", "status" : "active", "protocol_type" : "mcp", "protocol_configuration" : { "mcp" : { "search_configuration" : { "search_type" : "semantic", "top_n" : 6, "score_threshold" : "0.6" }, "supported_versions" : [ "2025-03-26" ], "session_configuration" : { "enabled" : true } } }, "authorizer_type" : "custom_jwt", "agency_name" : "my-agency", "endpoint_url" : "https://b2fc0463-8b28-46c5-87ba-6267295ffc57.gateway.agentarts.cn-north-4.huaweicloudapis.com", "log_delivery_configuration" : { "enabled" : true, "log_group_id" : "6183535a-8eb7-435b-b32c-00ec997c15b6", "log_stream_id" : "4b81a675-cf35-45ab-8260-14ce70a8f15e" }, "workload_identity" : { "urn" : "agentIdentity:cn-north-4:9446b54a-f78e-4a5a-956e-e6ef73450599:workloadIdentity:gateway_my-gateway" }, "agent_gateway_id" : "b2fc0463-8b28-46c5-87ba-6267295ffc57", "outbound_network_configuration" : { "network_mode" : "public" }, "tags" : [ { "key" : "Environment", "value" : "production" }, { "key" : "Team", "value" : "ai-platform" } ], "created_at" : "2024-01-15T10:30:00Z", "updated_at" : "2024-01-15T10:30:00Z" } ``` **状态码：404** 资源未找到 ``` { "error_code" : "AgentArts.02000100", "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 | 成功检索网关详情 | | 404 | 资源未找到 | | 401 | 认证信息无法识别 | | 403 | 权限不足，拒绝访问 | | 429 | 请求频率超限。 | | 500 | 内部服务器错误 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-agentarts/ErrorCode.html)。