创建网关 - CreateCoreGateway

Content-Type

是

String

参数解释：

消息体编码格式。用于告知服务端请求体（Body）所采用的主体数据类型，以便服务端正确解析。

约束限制：

不涉及

取值范围：

application/json

默认取值：

application/json

Authorization

是

String

参数解释：

签名认证信息，当使用AK/SK方式认证时，使用SDK对请求进行签名的过程中会自动填充该字段。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

X-Sdk-Date

是

String

参数解释：

请求发送的时间，当使用AK/SK方式认证时，使用SDK对请求进行签名的过程中会自动填充该字段。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

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时，此字段可选或为空。

取值范围：

不涉及。

默认取值：

不涉及。

log_delivery_configuration

否

CoreGatewayLogDeliveryConfigurationRequestBody object

参数解释：

日志上报配置。

约束范围：

不涉及。

取值范围：

• enabled为true时，表示启用日志上报，需填写 log_group_id 和 log_stream_id。

• 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 CoreGatewayTag objects

参数解释：

资源标签列表。

约束范围：

不涉及。

取值范围：

数组长度为 0-20。

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

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

默认取值：

不涉及。

custom_jwt_authorizer

否

CoreGatewayCustomJWTAuthorizerConfiguration object

参数解释：

自定义JWT认证配置。

约束范围：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

key_auth

否

CoreGatewayKeyAuthAuthorizerConfiguration object

参数解释：

API 密钥认证配置，支持多个 API 密钥同时生效（用于密钥轮换）。

约束范围：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

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。

默认取值：

不涉及。

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

参数解释：

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

约束范围：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

match_operator

是

String

参数解释：

匹配操作符。

约束范围：

不涉及。

取值范围：

• equals: 精确匹配

• contains: 包含指定值

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

默认取值：

不涉及。

match_value

是

CoreGatewayMatchValue object

参数解释：

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

约束范围：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

match_value_string

否

String

参数解释：

单个匹配值。

约束范围：

不涉及。

取值范围：

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

默认取值：

不涉及。

match_value_string_list

否

Array of strings

参数解释：

匹配值列表。

约束范围：

不涉及。

取值范围：

数组长度为 1-20。

默认取值：

不涉及。

api_keys

是

Array of CoreGatewayApiKeyConfiguration objects

参数解释：

API 密钥列表。

约束范围：

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

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

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

取值范围：

数组长度为 0-10。

默认取值：

不涉及。

api_key_name

是

String

参数解释：

API 密钥的资源名称。

约束范围：

不涉及。

取值范围：

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

默认取值：

不涉及。

api_key

否

String

参数解释：

API 密钥值。

约束范围：

不涉及。

取值范围：

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

默认取值：

不涉及。

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

默认取值：

不涉及。

network_mode

是

String

参数解释：

网络模式。

约束范围：

不涉及。

取值范围：

• public: 使用公网访问

• vpc: 使用VPC网络访问（需配置vpc_config）

默认取值：

不涉及。

vpc_config

否

CoreGatewayVpcConfig object

参数解释：

VPC网络配置。

约束范围：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

vpc_id

是

String

参数解释：

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。

约束范围：

不涉及。

取值范围：

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

默认取值：

不涉及。

key

是

String

参数解释：

标签键。

约束范围：

不涉及。

取值范围：

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

默认取值：

不涉及。

value

是

String

参数解释：

标签值。

约束范围：

不涉及。

取值范围：

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

默认取值：

不涉及。

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）

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-southwest-2.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。

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

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

created_at

String

参数解释：

网关创建时间戳。

取值范围：

不涉及。

updated_at

String

参数解释：

网关最后更新时间戳。

取值范围：

不涉及。

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

urn

String

参数解释：

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

取值范围：

长度为 1-200 个字符。

network_mode

String

参数解释：

网络模式。

约束范围：

不涉及。

取值范围：

• public: 使用公网访问

• vpc: 使用VPC网络访问（需配置vpc_config）

默认取值：

不涉及。

vpc_config

CoreGatewayVpcConfig object

参数解释：

VPC网络配置。

约束范围：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

vpc_id

String

参数解释：

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。

约束范围：

不涉及。

取值范围：

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

默认取值：

不涉及。

key

String

参数解释：

标签键。

约束范围：

不涉及。

取值范围：

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

默认取值：

不涉及。

value

String

参数解释：

标签值。

约束范围：

不涉及。

取值范围：

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

默认取值：

不涉及。

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

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

encoded_authorization_message

String

参数解释：

编码后的授权失败信息，可通过统一身份认证服务IAM的解密鉴权失败的原因接口解码获取详细授权失败原因。

取值范围：

取值为 1-4096 个字符。

details

Array of CoreGatewayCommonError objects

参数解释：

依赖的下游服务错误信息列表。

取值范围：

数组长度为 0-10。

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

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

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

201

网关创建成功

400

无效的请求体

403

权限不足，拒绝访问

409

网关已存在

500

内部服务器错误