更新时间:2026-07-17 GMT+08:00
分享

创建网关 - CreateCoreGateway

功能介绍

使用指定配置创建一个新的网关。

调用方法

请参见如何调用API

授权信息

账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

agentarts:gateway:createCoreGateway

Write

gateway *

-

-

  • iam:agencies:pass
  • vpc:nativePorts:create
  • vpc:routeTables:update
  • eip:publicIps:associateInstance

-

  • g:RequestTag/<tag-key>

  • g:TagKeys

URI

POST /v1/core/gateways

请求参数

表1 请求Body参数

参数

是否必选

参数类型

描述

name

String

参数解释:

网关名称。

约束限制:

账户下网关名称唯一(不区分大小写)。

取值范围:

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

默认取值:

不涉及。

description

String

参数解释:

网关的详细描述。

约束限制:

不涉及。

取值范围:

长度为 0-1000 个字符。

默认取值:

不涉及。

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 个字符。

默认取值:

不涉及。

authorizer_configuration

CoreGatewayAuthorizerConfiguration object

参数解释:

授权器配置。

约束限制:

  • 当authorizer_type的值为CUSTOM_JWT时,须配置custom_jwt_authorizer。

  • 当authorizer_type的值为API_KEY时,须配置key_auth。

  • 当authorizer_type的值为IAM时,此字段可选或为空。

取值范围:

不涉及。

默认取值:

不涉及。

protocol_configuration

CoreGatewayProtocolConfiguration object

参数解释:

网关协议的自定义设置。

约束限制:

  • 当protocol_type的值为mcp时,可以配置mcp。

取值范围:

不涉及。

默认取值:

不涉及。

log_delivery_configuration

CoreGatewayLogDeliveryConfigurationRequestBody object

参数解释:

日志上报配置。

约束限制:

不涉及。

取值范围:

  • enabled为true时,表示启用日志上报。

  • enabled为false时,表示禁用日志上报。

默认取值:

不涉及。

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 CoreGatewayTagForRequest objects

参数解释:

资源标签列表。

约束限制:

不涉及。

取值范围:

数组长度为 0-20。

默认取值:

不涉及。

表2 CoreGatewayAuthorizerConfiguration

参数

是否必选

参数类型

描述

custom_jwt_authorizer

CoreGatewayCustomJWTAuthorizerConfiguration object

参数解释:

自定义JWT认证配置。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

key_auth

CoreGatewayKeyAuthAuthorizerConfiguration object

参数解释:

API 密钥认证配置,支持多个 API 密钥同时生效(用于密钥轮换)。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表3 CoreGatewayCustomJWTAuthorizerConfiguration

参数

是否必选

参数类型

描述

discovery_url

String

参数解释:

JWT 发现 URL。

约束限制:

不涉及。

取值范围:

长度为 1-2048 个字符,匹配以 https:// 开头、中间至少包含一个任意字符、并以 /.well-known/openid-configuration

结尾的 URL,符合正则条件^https://.+/.well-known/openid-configuration$。

默认取值:

不涉及。

allowed_audience

Array of strings

参数解释:

允许的 JWT 受众(aud)列表,用于验证令牌的预期接收者。

约束限制:

不允许重复。

取值范围:

数组长度为 0-100。

默认取值:

不涉及。

allowed_clients

Array of strings

参数解释:

允许的客户端 ID 列表,用于限制哪些客户端可以访问。

约束限制:

不允许重复。

取值范围:

数组长度为 0-100。

默认取值:

不涉及。

allowed_scopes

Array of strings

参数解释:

允许的 JWT 作用域(scope)列表,用于控制访问权限。

约束限制:

不允许重复。

取值范围:

数组长度为 0-100。

默认取值:

不涉及。

custom_claims

Array of CoreGatewayCustomClaimValidation objects

参数解释:

自定义声明验证规则列表,用于验证 JWT 中的自定义声明。

约束限制:

不允许重复。

取值范围:

数组长度为 0-100。

默认取值:

不涉及。

表4 CoreGatewayCustomClaimValidation

参数

是否必选

参数类型

描述

inbound_token_claim_name

String

参数解释:

声明名称。

约束限制:

不涉及。

取值范围:

长度为1-255个字符,由字母、数字、下划线、点、短横线或冒号组成的一个或多个字符的完整字符串,符合正则条件^[A-Za-z0-9_.-:]+$。

默认取值:

不涉及。

inbound_token_claim_value_type

String

参数解释:

入站令牌声明值类型。

约束限制:

不涉及。

取值范围:

  • string: 字符串类型

  • string_array: 字符串数组类型

默认取值:

不涉及。

authorizing_claim_match_value

CoreGatewayAuthorizingClaimMatchValue object

参数解释:

授权声明匹配值配置,定义如何匹配声明值。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表5 CoreGatewayAuthorizingClaimMatchValue

参数

是否必选

参数类型

描述

match_operator

String

参数解释:

匹配操作符。

约束限制:

不涉及。

取值范围:

  • equals: 精确匹配

  • contains: 包含指定值

  • contains_any: 包含任意一个指定值

默认取值:

不涉及。

match_value

CoreGatewayMatchValue object

参数解释:

匹配值,支持单个字符串或字符串列表。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表6 CoreGatewayMatchValue

参数

是否必选

参数类型

描述

match_value_string

String

参数解释:

单个匹配值。

约束限制:

不涉及。

取值范围:

长度为 1-255 个字符,由字母、数字、下划线、点或短横线组成的一个或多个字符的完整字符串,符合正则条件^[A-Za-z0-9_.-]+$。

默认取值:

不涉及。

match_value_string_list

Array of strings

参数解释:

匹配值列表。

约束限制:

不涉及。

取值范围:

数组长度为 1-20。

默认取值:

不涉及。

表7 CoreGatewayKeyAuthAuthorizerConfiguration

参数

是否必选

参数类型

描述

api_keys

Array of CoreGatewayApiKeyConfiguration objects

参数解释:

API 密钥列表。

约束限制:

  • 支持多个 API 密钥同时有效(用于密钥轮换)

  • 每个密钥为独立对象,包含密钥值和可选的名称

注意:数组为空时系统将自动生成1个有效的 API 密钥。

取值范围:

数组长度为 0-10。

默认取值:

不涉及。

表8 CoreGatewayApiKeyConfiguration

参数

是否必选

参数类型

描述

api_key_name

String

参数解释:

API 密钥的资源名称。

约束限制:

不涉及。

取值范围:

长度为 1-64个字符,由字母、数字、下划线或短横线组成的一个或多个字符的完整字符串,符合正则条件^[a-zA-Z0-9_-]+$。为空时系统将自动生成随机名称。

默认取值:

不涉及。

api_key

String

参数解释:

API 密钥值。

约束限制:

不涉及。

取值范围:

长度为 0-512个字符,由字母、数字、短横线或下划线组成的一个或多个字符的完整字符串,符合正则条件^[A-Za-z0-9-_]+$。

默认取值:

不涉及。

表9 CoreGatewayProtocolConfiguration

参数

是否必选

参数类型

描述

mcp

CoreGatewayMcpProtocolConfiguration object

参数解释:

MCP网关配置。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表10 CoreGatewayMcpProtocolConfiguration

参数

是否必选

参数类型

描述

search_configuration

CoreGatewaySearchConfiguration object

参数解释:

搜索操作配置。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

supported_versions

Array of strings

参数解释:

MCP网关支持的协议版本列表,支持选择的MCP版本:2025-03-26、2025-06-18、2025-11-25。

约束限制:

不涉及。

取值范围:

每个元素为YYYY-MM-DD格式的MCP协议版本号。

默认取值:

[2025-03-26]。

表11 CoreGatewaySearchConfiguration

参数

是否必选

参数类型

描述

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

默认取值:

0.7。

表12 CoreGatewayLogDeliveryConfigurationRequestBody

参数

是否必选

参数类型

描述

enabled

Boolean

参数解释:

是否启用日志上报。

约束限制:

不涉及。

取值范围:

当取值为true时,表示启用日志上报。当取值为false时,表示不启用日志上报。

默认取值:

不涉及。

表13 CoreGatewayOutboundNetworkConfiguration

参数

是否必选

参数类型

描述

network_mode

String

参数解释:

网络模式。

约束限制:

不涉及。

取值范围:

  • public: 使用公网访问

  • vpc: 使用VPC网络访问(需配置vpc_config)

默认取值:

不涉及。

vpc_config

CoreGatewayVpcConfig object

参数解释:

VPC网络配置。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表14 CoreGatewayVpcConfig

参数

是否必选

参数类型

描述

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。

默认取值:

不涉及。

表15 CoreGatewayTagForRequest

参数

是否必选

参数类型

描述

key

String

参数解释:

标签键。

约束限制:

key不能为空或者空字符串,不能为空格。

取值范围:

最大长度128个unicode字符,可用 UTF-8 格式表示的字母、数字和空格,以及以下字符:_ . : / = + - @。

默认取值:

不涉及。

value

String

参数解释:

标签值。

约束限制:

value可以为空字符串。

取值范围:

最大长度255个unicode字符,可用 UTF-8 格式表示的字母、数字和空格,以及以下字符:_ . : / = + - @。

默认取值:

不涉及。

响应参数

状态码:201

表16 响应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

参数解释:

网关协议的自定义设置。

约束限制:

  • 当protocol_type的值为mcp时,可以配置mcp。

取值范围:

不涉及。

默认取值:

不涉及。

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_id>.gateway.agentarts.<region_code>.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。

表17 CoreGatewayProtocolConfiguration

参数

参数类型

描述

mcp

CoreGatewayMcpProtocolConfiguration object

参数解释:

MCP网关配置。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表18 CoreGatewayMcpProtocolConfiguration

参数

参数类型

描述

search_configuration

CoreGatewaySearchConfiguration object

参数解释:

搜索操作配置。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

supported_versions

Array of strings

参数解释:

MCP网关支持的协议版本列表,支持选择的MCP版本:2025-03-26、2025-06-18、2025-11-25。

约束限制:

不涉及。

取值范围:

每个元素为YYYY-MM-DD格式的MCP协议版本号。

默认取值:

[2025-03-26]。

表19 CoreGatewaySearchConfiguration

参数

参数类型

描述

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

默认取值:

0.7。

表20 CoreGatewayLogDeliveryConfiguration

参数

参数类型

描述

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

表21 CoreGatewayWorkloadIdentity

参数

参数类型

描述

urn

String

参数解释:

工作负载标识的统一资源名称,格式为''agentIdentity:<region-id>:<account-id>:workloadIdentity:gateway_<gateway-name>''。

取值范围:

长度为 1-200 个字符。

表22 CoreGatewayOutboundNetworkConfiguration

参数

参数类型

描述

network_mode

String

参数解释:

网络模式。

约束限制:

不涉及。

取值范围:

  • public: 使用公网访问

  • vpc: 使用VPC网络访问(需配置vpc_config)

默认取值:

不涉及。

vpc_config

CoreGatewayVpcConfig object

参数解释:

VPC网络配置。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表23 CoreGatewayVpcConfig

参数

参数类型

描述

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。

默认取值:

不涉及。

表24 CoreGatewayTag

参数

参数类型

描述

key

String

参数解释:

标签键。

取值范围:

最大长度128个unicode字符,可用 UTF-8 格式表示的字母、数字和空格,以及以下字符:_ . : / = + - @。

value

String

参数解释:

标签值。

取值范围:

最大长度255个unicode字符,可用 UTF-8 格式表示的字母、数字和空格,以及以下字符:_ . : / = + - @。

状态码:400

表25 响应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

表26 响应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

表27 响应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。

表28 CoreGatewayCommonError

参数

参数类型

描述

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

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

状态码:409

表30 响应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

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

请求示例

{
  "name" : "my-gateway",
  "description" : "我的 MCP 网关",
  "protocol_type" : "mcp",
  "protocol_configuration" : {
    "mcp" : {
      "search_configuration" : {
        "search_type" : "semantic",
        "top_n" : 6,
        "score_threshold" : "0.6"
      },
      "supported_versions" : [ "2025-03-26" ],
    }
  },
  "authorizer_type" : "custom_jwt",
  "agency_name" : "my-agency",
  "authorizer_configuration" : {
    "custom_jwt_authorizer" : {
      "discovery_url" : "https://auth.example.com/.well-known/openid-configuration",
      "allowed_audience" : [ "my-api" ],
      "allowed_clients" : [ "client-123" ],
      "allowed_scopes" : [ "read", "write" ]
    }
  },
  "log_delivery_configuration" : {
    "enabled" : true
  },
  "agent_gateway_id" : "b2fc0463-8b28-46c5-87ba-6267295ffc57",
  "outbound_network_configuration" : {
    "network_mode" : "public"
  },
  "tags" : [ {
    "key" : "Environment",
    "value" : "production"
  }, {
    "key" : "Team",
    "value" : "ai-platform"
  } ]
}

响应示例

状态码:201

网关创建成功

{
  "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" ],
    }
  },
  "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:c9d3a14f-9038-4505-8bec-da2ea55697dc: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"
}

状态码: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" : "稍后重试"
}

状态码:409

网关名称重复

{
  "error_code" : "AgentArts.02000601",
  "error_msg" : "网关名称重复",
  "error_reason" : "网关名称重复",
  "error_suggestion" : "请更换名称"
}

状态码:500

内部服务器错误

{
  "error_code" : "AgentArts.02000500",
  "error_msg" : "服务连接超时",
  "error_reason" : "服务连接超时",
  "error_suggestion" : "请稍后重试"
}

状态码

状态码

描述

201

网关创建成功

400

请求参数错误

401

认证信息无法识别

403

权限不足,拒绝访问

429

请求频率超限。

409

网关名称重复

500

内部服务器错误

错误码

请参见错误码

相关文档