帮你快速理解、总结文档立即下载

数据结构

最近更新时间:2026-09-21 01:22:28
我的收藏

AIGWACLSubject

AI 网关 ACL 授权主体(Consumer / ConsumerGroup 共用结构),用于响应中回显 Id + Name,减少前端多次查询调用

被如下接口引用:DescribeCloudNativeAPIGatewayMCPServerACL, DescribeCloudNativeAPIGatewayMCPToolACLList。

名称 类型 描述
Id String

鉴权主体ID


示例值:*
Name String

鉴权主体名称


示例值:默认消费者组

AIGWAKSKCredentialConfig

aksk类型密钥

被如下接口引用:CreateCloudNativeAPIGatewaySecretKey, DescribeCloudNativeAPIGatewaySecretKey, DescribeCloudNativeAPIGatewaySecretKeyList。

名称 类型 必选 描述
AccessKeyId String 否

AccessKeyId


示例值:FKI****EE8
SecretAccessKey String 否

SecretAccessKey


示例值:fak****ake

AIGWAuthModelScopeItem

AI网关授权模型访问范围

被如下接口引用:DescribeCloudNativeAPIGatewayLLMModelAPI。

名称 类型 必选 描述
PrincipalId String 否

授权主体 ID,如消费者组、消费者


示例值:cg-393266dc6f5f2c
PrincipalName String 否

授权主体名称,如消费者组、消费者


示例值:deepx
ModelScope AIGWModelScope 否

模型范围原始配置

EffectiveModelNames Array of String 否

MAG 已展开、保序去重后的可用模型名称列表


示例值:["deepseek-v4-flash"]

AIGWBasicCredentialConfig

AI网关 Basic Auth 凭证物料配置

被如下接口引用:CreateCloudNativeAPIGatewaySecretKey, DescribeCloudNativeAPIGatewaySecretKey, DescribeCloudNativeAPIGatewaySecretKeyList。

名称 类型 必选 描述
Password String 否

密码


示例值:my-secret*
Username String 否

用户名


示例值:admin

AIGWBearerTokenCredentialConfig

AI网关 Bearer Token 凭证配置

被如下接口引用:CreateCloudNativeAPIGatewaySecretKey, DescribeCloudNativeAPIGatewaySecretKey, DescribeCloudNativeAPIGatewaySecretKeyList。

名称 类型 必选 描述
Token String 否

Token凭证


示例值:sk-test-demo-**

AIGWCAMCredentialConfig

CAM类型密钥

被如下接口引用:CreateCloudNativeAPIGatewaySecretKey, DescribeCloudNativeAPIGatewaySecretKey, DescribeCloudNativeAPIGatewaySecretKeyList。

名称 类型 必选 描述
SecretId String 否

SecretId


示例值:fak****-ak
SecretKey String 否

SecretKey


示例值:fak****-sk

AIGWCacheAwareRouteCandidate

缓存感知路由候选模型服务

被如下接口引用:CreateCloudNativeAPIGatewayLLMModelAPI, ModifyCloudNativeAPIGatewayLLMModelAPI。

名称 类型 必选 描述
ModelServiceId String 否

模型服务ID


示例值:d8bbb1a7b70341a4ba94ea77de091de3
ModelServiceName String 否

模型服务名称


示例值:ds-2

AIGWCacheAwareRouteConfig

缓存感知路由

被如下接口引用:CreateCloudNativeAPIGatewayLLMModelAPI, ModifyCloudNativeAPIGatewayLLMModelAPI。

名称 类型 必选 描述
Candidates Array of AIGWCacheAwareRouteCandidate 否

前缀缓存感知路由模型服务列表

AIGWChangeSummary

版本变更的兼容变更,破坏变更数

被如下接口引用:CompareCloudNativeAPIGatewayMCPToolVersion。

名称 类型 描述
Breaking Integer

破坏性变更数


示例值:0
Compatible Integer

兼容性变更数


示例值:1

AIGWConsumerGroupBrief

AI 网关中消费者组简要信息

被如下接口引用:DescribeCloudNativeAPIGatewayLLMTokenUsageList。

名称 类型 描述
Name String

消费者组名称


示例值:test-consumer-group-1
ConsumerGroupId String

消费者组Id


示例值:cg-3155bd3c9fd0df

AIGWConsumerModelScope

AI网关消费者模型范围

被如下接口引用:DescribeCloudNativeAPIGatewayLLMModelAPI。

名称 类型 必选 描述
ScopeType String 否

消费者模型生效范围类型

枚举值:

  • INHERIT: 继承所在消费者组的生效模型范围
  • ALLOWLIST: 自定义白名单,必须 ⊆ 所在组针对该资源的生效模型集合

示例值:ALLOWLIST
AllowList Array of String 否

模型授权白名单列表


示例值:["claude-haiku-4-5"]

AIGWCreateMCPRouteResult

新建MCP路由结果

被如下接口引用:CreateCloudNativeAPIGatewayMCPRoute。

名称 类型 描述
RouteId String

路由ID


示例值:9f63826c-cf7b-4658-ac67-6fd96df49944
Success Boolean

结果


示例值:true

AIGWCrossServiceFallbackConfig

跨服务降级配置

被如下接口引用:CreateCloudNativeAPIGatewayLLMModelAPI, DescribeCloudNativeAPIGatewayLLMModelAPI, ModifyCloudNativeAPIGatewayLLMModelAPI。

名称 类型 必选 描述
TriggerConditions Array of String 是

触发条件

枚举值:

  • ServiceUnavailable: 服务不可用
  • ConnectionTimeout: 连接超时
  • RateLimited: 限流

示例值:["ServiceUnavailable"]
FallbackServiceChain Array of AIGWFallbackServiceItem 是

fallback 服务链

QuotaFallbackTrigger AIGWLLMQuotaFallbackTrigger 否

额度降级触发配置

AIGWCustomDesensitizeRule

AI 网关自定义脱敏规则

被如下接口引用:DescribeCloudNativeAPIGatewayLLMModelAPI。

名称 类型 必选 描述
Name String 是

规则名称,同一配置内唯一,最长 64


示例值:员工工号
Pattern String 是

RE2 兼容的正则表达式


示例值:EMP-[0-9]{6}
MaskFormat String 是

日志场景为掩码格式,转发场景为占位符;最长 64


示例值:E***
Enabled Boolean 是

单条自定义规则是否启用


示例值:true

AIGWCustomHeaderCredentialConfig

AI网关自定义 Header 凭证配置

被如下接口引用:CreateCloudNativeAPIGatewaySecretKey, DescribeCloudNativeAPIGatewaySecretKey, DescribeCloudNativeAPIGatewaySecretKeyList。

名称 类型 必选 描述
HeaderName String 否

Header名


示例值:X-App-Token
HeaderValue String 否

Header值


示例值:my-custom-****

AIGWFallbackServiceItem

降级服务元素

被如下接口引用:CreateCloudNativeAPIGatewayLLMModelAPI, ModifyCloudNativeAPIGatewayLLMModelAPI。

名称 类型 必选 描述
ModelServiceId String 是

模型服务 Id


示例值:3dcaac5d48cc4d39a8ed79937fe720c6
ModelServiceName String 否

模型服务名


示例值:mock-openai

AIGWForwardDesensitizeConfig

AI 网关转发脱敏配置

被如下接口引用:DescribeCloudNativeAPIGatewayLLMModelAPI。

名称 类型 必选 描述
Enabled Boolean 是

转发脱敏配置总开关


示例值:true
PredefinedRuleTypes Array of String 否

内置规则类型:Phone、IdCard、BankCard、Email、IP、Name


示例值:["Phone", "Email"]
CustomRules Array of AIGWCustomDesensitizeRule 否

自定义规则,最多 20 条

PlaceholderFormat String 否

内置规则占位符格式,最长 32;为空时默认 [{type}]


示例值:[{type}]
OnFailure String 否

脱敏失败处理:Reject(拒绝请求)或 Skip(跳过脱敏并转发)


示例值:Reject

AIGWHeaderRule

MCP路由 Header规则对象

被如下接口引用:CheckCloudNativeAPIGatewayMCPRouteMatch, CreateCloudNativeAPIGatewayMCPRoute, DescribeCloudNativeAPIGatewayMCPRouteList, ModifyCloudNativeAPIGatewayMCPRoute。

名称 类型 必选 描述
Key String 是

Header的Key


示例值:X-Tenant
MatchType String 是

Header匹配规则

枚举值:

  • Exact: 精确
  • Prefix: 前缀
  • Regex: 正则

示例值:Exact
Value String 是

Header匹配的值


示例值:tenant-a

AIGWHealthCheckSetting

用于定义kong插件自定义健康检查的配置

被如下接口引用:CreateCloudNativeAPIGatewayMCPServer, DescribeCloudNativeAPIGatewayMCPServer, ModifyCloudNativeAPIGatewayMCPServer。

名称 类型 必选 描述
HealthCheckType String 是

健康检查类型

枚举值:

  • MCP: 标准mcp
  • HTTP: http

示例值:MCP
HealthCheckIntervalSecond Integer 是

检查间隔


示例值:10
HealthCheckTimeout Integer 是

检查超时时间


示例值:3
HealthCheckFailThreshold Integer 是

检查失败阈值


示例值:3
HealthCheckRecoverThreshold Integer 是

检查恢复阈值


示例值:3
HealthCheckPath String 否

检查路径


示例值:/health
HealthCheckMethod String 否

检查方法


示例值:GET

AIGWIntentRoute

AI 网关意图路由配置

被如下接口引用:CreateCloudNativeAPIGatewayLLMModelAPI, ModifyCloudNativeAPIGatewayLLMModelAPI。

名称 类型 必选 描述
IntentModelServiceId String 是

意图识别模型id


示例值:d6015302e11b4a1f83dd3adb88180716
ConfidenceThreshold Float 是

置信度


示例值:0.75
DefaultModelServiceId String 是

默认服务id


示例值:d6015302e11b4a1f83dd3adb88180716
Rules Array of AIGWIntentRouteRule 否

规则

AIGWIntentRouteRule

AI 网关意图路由规则

被如下接口引用:CreateCloudNativeAPIGatewayLLMModelAPI, ModifyCloudNativeAPIGatewayLLMModelAPI。

名称 类型 必选 描述
IntentCode String 否

意图编码

枚举值:

  • Coder: 代码编写
  • Math: 数学计算
  • Translation: 翻译
  • Flash: 快速问答
  • Complex: 复杂推理

示例值:Coder
ModelServiceId String 否

模型服务id


示例值:d6015302e11b4a1f83dd3adb88180716

AIGWJWTAuthPluginConfig

JWT 认证插件配置

被如下接口引用:DescribeCloudNativeAPIGatewayMCPServerAuth, ModifyCloudNativeAPIGatewayMCPServerAuth。

名称 类型 必选 描述
HeaderNames Array of String 否

签名的header名称列表


示例值:["header"]
CookieNames Array of String 否

签名的cookie名称列表


示例值:["cookie"]
URIParamNames Array of String 否

签名的URL参数名称列表


示例值:["param"]
KeyClaimName String 否

消费者标识


示例值:claim
ClaimsToVerify Array of String 否

标准消费者校验

枚举值:

  • exp: exp
  • nbf: nbf

示例值:["exp"]
MaximumExpiration Integer 否

最大有效期


示例值:1000
SecretIsBase64 Boolean 否

是否Base64编码


示例值:true
RunOnPreFlight Boolean 否

CORS预检验证


示例值:true

AIGWJWTCredentialConfig

AI网关 JWT 凭证物料配置

被如下接口引用:CreateCloudNativeAPIGatewaySecretKey, DescribeCloudNativeAPIGatewaySecretKey, DescribeCloudNativeAPIGatewaySecretKeyList。

名称 类型 必选 描述
Algorithm String 是

签名算法,取值:HS256 HS384 HS512 RS256 RS384 RS512 ES256 ES384 ES512


示例值:ES256
Key String 是

JWT 消费者标识,iss claim


示例值:my-org-test-ES256
RSAPublicKey String 否

RS/ES PEM 格式公钥,仅 Algorithm 为 RS256/RS384/RS512/ES256/ES384/ES512 时必填;HS* 时留空


示例值:-----BEGIN PUBLIC KEY-----
**
Secret String 否

HS 对称密钥,仅 Algorithm 为 HS256/HS384/HS512 时必填;RS/ES* 时留空


示例值:****

AIGWKVMatch

路由匹配规则

被如下接口引用:CreateCloudNativeAPIGatewayLLMModelAPI, DescribeCloudNativeAPIGatewayLLMModelAPI, ModifyCloudNativeAPIGatewayLLMModelAPI。

名称 类型 必选 描述
Key String 是

键


示例值:k1
Value String 是

值


示例值:asdfad
Operator String 是

操作类型


示例值:exact

AIGWLLMHealthCheckSetting

AI网关LLM健康检查配置

被如下接口引用:DescribeCloudNativeAPIGatewayLLMModelService, DescribeCloudNativeAPIGatewayLLMModelServices。

名称 类型 必选 描述
HealthCheckFailThreshold Integer 是

检查失败阈值


示例值:1
HealthCheckIntervalSecond Integer 是

检查间隔


示例值:5
HealthCheckRecoverThreshold Integer 是

检查恢复阈值


示例值:1
HealthCheckTimeout Integer 是

检查超时时间


示例值:10
HealthCheckPath String 否

检查路径


示例值:/health

AIGWLLMModelServiceSubRoute

模型服务二级路由配置

被如下接口引用:CreateCloudNativeAPIGatewayLLMModelAPI, ModifyCloudNativeAPIGatewayLLMModelAPI。

名称 类型 必选 描述
SelectedTypes Array of String 是

生效的路由算法类型:权重路由,模型名称路由、参数路由等Weighted/ModelName/Query (预留多个,暂时只能填写一个)


示例值:["ModelService"]
WeightedConfig Array of CloudNativeAPIGatewayLLMModelServiceRouteWeightedStrategy 否

权重路由配置,最多10个

LatencyPriorityConfig AIGWLatencyPriorityConfig 否

延迟路由

ModelServiceConfig AIGWRouteModelServiceConfig 否

指定模型路由(暂时只用在Token长度路由时的子路由选择)

AIGWLLMQuotaFallbackTrigger

云原生网关模型API 配额降级触发条件信息

被如下接口引用:CreateCloudNativeAPIGatewayLLMModelAPI, ModifyCloudNativeAPIGatewayLLMModelAPI。

名称 类型 必选 描述
ThresholdPercent Integer 否

配额感知阈值百分比(RPM 与 TPM 共用)

取值范围:[0, 99]


示例值:10
CheckDimension String 否

检查维度策略

枚举值:

  • AnyInsufficient: RPM 或 TPM 任一不足即触发
  • AllInsufficient: RPM 和 TPM 同时不足才触发

示例值:AnyInsufficient

AIGWLLMQuotaLimit

云原生网关模型LLM配额限制信息

被如下接口引用:CreateCloudNativeAPIGatewayLLMModelService, DescribeCloudNativeAPIGatewayLLMModelService, DescribeCloudNativeAPIGatewayLLMModelServices, ModifyCloudNativeAPIGatewayLLMModelService。

名称 类型 必选 描述
RPMLimit Integer 否

该模型服务每分钟请求数上限,0 表示该维度不限


示例值:0
TPMLimit Integer 否

该模型服务每分钟 Token 数上限,0 表示该维度不限


示例值:0
ConcurrentCountLimit Integer 否

并发数限流


示例值:20

AIGWLLMTokenUsageItem

单个消费者 Token 用量查询结果

被如下接口引用:DescribeCloudNativeAPIGatewayLLMTokenUsageList。

名称 类型 描述
ConsumerId String

消费者Id


示例值:02b4d312-2fcd-4995-ae7c-5acaa57962b7
ConsumerName String

消费者名称


示例值:test-consumer-1
ConsumerGroups Array of AIGWConsumerGroupBrief

消费者组信息列表

ModelServiceId String

模型服务Id


示例值:f77b443101e9411ab881f183079c073a
ModelServiceName String

模型服务名称


示例值:anthropic-deepseek
InputTokens Integer

输入Token数(包含缓存命中Token数)


示例值:5736
CacheReadInputTokens Integer

命中缓存输入Token数


示例值:5632
OutputTokens Integer

输出Token数


示例值:969
TotalTokens Integer

消耗总Token数


示例值:6705
RequestCount Integer

请求总数


示例值:5
Cost String

花费成本


示例值:0.00
Currency String

成本货币单位

枚举值:

  • CNY: 人民币

当前仅支持CNY


示例值:CNY

AIGWLLMTokenUsageListResult

Token用量统计结果

被如下接口引用:DescribeCloudNativeAPIGatewayLLMTokenUsageList。

名称 类型 描述
DataList Array of AIGWLLMTokenUsageItem

Token用量明细返回结果列表

TotalCount Integer

结果总数


示例值:6

AIGWLLMTokenUsageStatisticsResult

AI 网关token消耗统计汇总响应结果

被如下接口引用:DescribeCloudNativeAPIGatewayLLMTokenUsageStatistics。

名称 类型 描述
TotalRequestCount Integer

查询时间范围内请求总数


示例值:2
TotalInputTokens Integer

查询时间范围内总输入Token数(包含命中缓存的Token数)


示例值:45
TotalOutputTokens Integer

查询时间范围内总输出Token数


示例值:11
TotalCachedReadInputTokens Integer

查询时间范围内总命中缓存输入Token数


示例值:5632
TotalCost String

查询时间范围内总成本


示例值:0.0
Currency String

成本货币单位


示例值:CNY
TopConsumers Array of AIGWTopConsumersItem

查询时间范围内成本最高的消费者

AIGWLatencyPriorityConfig

延迟优先路由配置

被如下接口引用:CreateCloudNativeAPIGatewayLLMModelAPI, ModifyCloudNativeAPIGatewayLLMModelAPI。

名称 类型 必选 描述
Rules Array of AIGWLatencyPriorityRouteRule 是

路由规则列表

LatencyMetric String 是

延迟指标

枚举值:

  • LLMLatency: LLM 延迟
  • NetworkLatency: 网络延迟

示例值:LLMLatency
RouteMode String 否

路由策略

枚举值:

  • FastMode: 快速模式
  • BalanceMode: 均衡模式

示例值:BalanceMode

AIGWLatencyPriorityRouteRule

AI 网关延迟优先路由模型服务

被如下接口引用:CreateCloudNativeAPIGatewayLLMModelAPI, ModifyCloudNativeAPIGatewayLLMModelAPI。

名称 类型 必选 描述
ModelServiceId String 是

模型服务id


示例值:4d3b21814ff540b6a1b3bc3c46a62793

AIGWLoadBalanceConfig

负载均衡配置,仅服务来源(ServiceSource,SourceId 非空)场景生效。

被如下接口引用:CreateCloudNativeAPIGatewayLLMModelService, DescribeCloudNativeAPIGatewayLLMModelService, DescribeCloudNativeAPIGatewayLLMModelServices, ModifyCloudNativeAPIGatewayLLMModelService。

名称 类型 必选 描述
Algorithm String 否

负载均衡类型

枚举值:

  • RoundRobin: 轮询
  • WeightedRoundRobin: 加权轮询
  • LeastConnections: 最少连接
  • Random: 随机

默认值:RoundRobin


示例值:WeightedRoundRobin

AIGWLogConfig

AI 网关日志输出配置

被如下接口引用:CreateCloudNativeAPIGatewayLLMModelAPI, CreateCloudNativeAPIGatewayMCPServer, DescribeCloudNativeAPIGatewayLLMModelAPI, DescribeCloudNativeAPIGatewayMCPServer, ModifyCloudNativeAPIGatewayLLMModelAPI, ModifyCloudNativeAPIGatewayMCPServer。

名称 类型 必选 描述
EnableRequestLogPayloads Boolean 否

是否开启请求 payload 记录日志


示例值:true
EnableResponseLogPayloads Boolean 否

是否开启响应 payload 记录日志


示例值:true
RequestLogPayloadMaxSize Integer 否

日志记录的请求body的最大字节数

取值范围:[512, 1048576]

EnableRequestLogPayloads 为true时必填


示例值:4096
ResponseLogPayloadMaxSize Integer 否

日志记录的响应body的最大字节数

取值范围:[512, 1048576]

EnableResponseLogPayloads 为true时必填


示例值:32768
RequestLogPayloadMode String 否

请求 payload access log 输出模式

枚举值:

  • raw: access log 中 body 记录客户端原始请求
  • processed: access log 中 body 记录 AI 网关协议适配、改写、归一化后的 OpenAI-compatible 内容

示例值:raw
ResponseLogPayloadMode String 否

上游原始 payload access log 输出模式

枚举值:

  • raw: access log 中 body 记录客户端原始上游响应
  • processed: access log 中 body 记录 AI 网关协议适配、改写、归一化后的 OpenAI-compatible 内容

示例值:raw
RequestLogPayloadTruncationPolicy String 否

请求 Body 大小裁剪策略

枚举值:

  • Bounded: 裁剪大小
  • UnBounded: 不裁剪大小

示例值:Bounded
ResponseLogPayloadTruncationPolicy String 否

响应 Body 大小裁剪策略

枚举值:

  • Bounded: 裁剪大小
  • UnBounded: 不裁剪大小

示例值:Bounded

AIGWLogDesensitizeConfig

AI 网关日志脱敏配置

被如下接口引用:DescribeCloudNativeAPIGatewayLLMModelAPI。

名称 类型 必选 描述
Enabled Boolean 是

日志脱敏配置总开关


示例值:true
PredefinedRuleTypes Array of String 否

内置规则类型:Phone、IdCard、BankCard、Email、IP、Name


示例值:["Phone", "Email"]
CustomRules Array of AIGWCustomDesensitizeRule 否

自定义规则,最多 20 条

Scope Array of String 否

脱敏方向:Request、Response;为空时默认两者


示例值:["Request", "Response"]

AIGWMCPRoute

MCP路由对象

被如下接口引用:DescribeCloudNativeAPIGatewayMCPRouteList。

名称 类型 描述
CreateTime String

创建时间


示例值:2026-07-03T14:29:35+08:00
Expression String

路由表达式


示例值:http.headers.x_tenant == "tenant-a"
HeaderMatch Array of AIGWHeaderRule

Header匹配规则

IsDefault Boolean

是否为默认路由

枚举值:

  • true: 是
  • false: 否

示例值:true
Methods Array of String

http path


示例值:["OPTIONS"]
Name String

路由名称


示例值:default
Path String

路由路径


示例值:/mcpservers/my-mcp-server/mcp
PathMatchType String

路径匹配方式

枚举值:

  • Exact: 精确
  • Prefix: 前缀
  • Regex: 正则

示例值:Exact
Priority Integer

优先级


示例值:0
RouteId String

路由ID


示例值:f8d4b985-641f-4010-a202-4559af81df6d
Status String

启用/禁用状态

枚举值:

  • Enabled: 启用
  • Disabled: 禁用

示例值:Enabled
PreserveHost Boolean

是否开启保留原Host功能


示例值:true

AIGWMCPRouteCheckResult

MCP路由规则的校验结果

被如下接口引用:CheckCloudNativeAPIGatewayMCPRouteMatch。

名称 类型 描述
ConflictRouteId String

冲突路由ID


示例值:1d328e9d-a65c-48b5-ae78-cfc56142baa1
IsConflict Boolean

是否冲突

枚举值:

  • true: 冲突
  • false: 未冲突

示例值:true
Reason String

冲突原因


示例值:route match spec conflicts with an existing route in this server

AIGWMCPRouteListResult

MCP 路由列表分页查询结果

被如下接口引用:DescribeCloudNativeAPIGatewayMCPRouteList。

名称 类型 描述
DataList Array of AIGWMCPRoute

路由列表

TotalCount Integer

总数


示例值:3

AIGWMCPServer

MCP Server详情

被如下接口引用:DescribeCloudNativeAPIGatewayMCPServer, DescribeCloudNativeAPIGatewayMCPServerList。

名称 类型 必选 描述
ServerId String 是

MCP Server ID


示例值:667065f5-6796-4430-b987-9a8b43c3d5b1
Name String 是

MCP Server名称


示例值:gitee
ServerType String 是

MCP Server类型,取值:MCP/Rest2MCP


示例值:MCP
Transport String 是

协议类型,取值: StreamableHttp


示例值:StreamableHttp
UpstreamType String 是

后端类型

枚举值:

  • MCPRegistry: mcp 注册中心
  • Registry: 普通注册中心
  • HostIP: 域名或ip
  • VirtualMCPServer: 虚拟MCPServer
  • DNS: 私有域名
  • Kubernetes: Kubernetes服务

示例值:HostIP
DisplayName String 否

展示名字


示例值:giteeasd
MCPEndpoint String 否

MCP提供给客户端的Endpoint


示例值:/mcpservers/gitee/mcp
UpstreamInfo AIGWMCPUpstreamInfoDetail 否

注册中心来源信息


注意:此字段可能返回 null,表示取不到有效值。
SessionConfig AIGWMCPSessionConfig 否

会话配置


注意:此字段可能返回 null,表示取不到有效值。
Timeout Integer 否

超时时间,单位ms


示例值:3000
RetryCount Integer 否

失败重试次数


示例值:3
CreateTime String 否

创建时间


示例值:2026-04-15 16:50:50
UpdateTime String 否

更新时间


示例值:2026-04-15 16:54:34
Description String 否

描述


示例值:webflux-mcp-server
Status String 否

运行状态

枚举值:

  • Online: 在线
  • Offline: 离线
  • Error: 错误

示例值:Online
EnableHealthCheck Boolean 否

是否启用健康检查


示例值:true
HealthCheck AIGWHealthCheckSetting 否

健康检查配置


注意:此字段可能返回 null,表示取不到有效值。
ToolCountLimit Integer 否

Tool分组内工具数量限制


示例值:100
ConflictStrategy String 否

Tool分组内工具命名冲突策略

枚举值:

  • AutoPrefix: 自动前缀
  • Reject: 拒绝

示例值:AutoPrefix
MarketStatus String 否

MCP 市场发布状态

枚举值:

  • None: 未发布
  • Published: 已发布

示例值:None
PreserveHost Boolean 否

是否开启保留原Host功能


示例值:true
LogConfig AIGWLogConfig 否

日志采集配置

AIGWMCPServerACLResult

AI 网关 MCP Server ACL 配置详情

被如下接口引用:DescribeCloudNativeAPIGatewayMCPServerACL。

名称 类型 描述
ACLType String

黑白名单鉴权类型

枚举值:

  • None: 不鉴权
  • Allow: 白名单
  • Deny: 黑名单

示例值:Deny
ACLConsumers Array of AIGWACLSubject

关联的消费者ID列表

ACLConsumerGroups Array of AIGWACLSubject

关联的消费者组ID列表

AuthType String

认证类型

枚举值:

  • None: 无认证
  • ApiKey: API Key认证

示例值:ApiKey

AIGWMCPServerAuthResult

AI 网关 MCP Server 认证配置详情

被如下接口引用:DescribeCloudNativeAPIGatewayMCPServerAuth。

名称 类型 描述
AuthType String

MCP服务认证类型

枚举值:

  • None: 无认证
  • ApiKey: API Key认证

示例值:ApiKey
JWTAuthConfig AIGWJWTAuthPluginConfig

JWT认证配置

OAuthAuthConfig AIGWOAuthAuthPluginConfig

OAuth2认证配置

OIDCAuthConfig AIGWOIDCAuthPluginConfig

OIDC认证配置

AIGWMCPServerList

MCP Server 列表

被如下接口引用:DescribeCloudNativeAPIGatewayMCPServerList。

名称 类型 必选 描述
TotalCount Integer 是

总数


示例值:4
DataList Array of AIGWMCPServer 否

mcp server 数据列表


注意:此字段可能返回 null,表示取不到有效值。

AIGWMCPSessionConfig

云原生网关MCP会话配置

被如下接口引用:CreateCloudNativeAPIGatewayMCPServer, DescribeCloudNativeAPIGatewayMCPServer, ModifyCloudNativeAPIGatewayMCPServer。

名称 类型 必选 描述
SessionStorage String 否

会话存储类型

枚举值:

  • memory: 内存
  • redis: redis

示例值:redis
RedisConfig AIGWRedisConfig 否

Redis配置

AIGWMCPToolACLItem

AI 网关 Tool ACL 单条记录(DescribeMCPToolACLList 数组元素)

被如下接口引用:DescribeCloudNativeAPIGatewayMCPToolACLList。

名称 类型 描述
ToolId String

MCP工具ID


示例值:****----****
ToolName String

MCP工具名称


示例值:get_weather_mock
ACLType String

MCP工具鉴权类型

枚举值:

  • None: 继承server鉴权类型
  • Allow: 白名单
  • Deny: 黑名单

示例值:None
ACLConsumers Array of AIGWACLSubject

关联的消费者ID列表

ACLConsumerGroups Array of AIGWACLSubject

关联的消费者组ID列表

AIGWMCPToolACLListResult

AI 网关 mcp server 下所有 tool 的 ACL 状态

被如下接口引用:DescribeCloudNativeAPIGatewayMCPToolACLList。

名称 类型 描述
ACLType String

黑白名单鉴权类型

枚举值:

  • None: 不鉴权
  • Allow: 白名单
  • Deny: 黑名单

示例值:Deny
DataList Array of AIGWMCPToolACLItem

数据列表

TotalCount Integer

计数


示例值:0

AIGWMCPToolVersion

mcp tool版本信息

被如下接口引用:DescribeCloudNativeAPIGatewayMCPToolVersionList。

名称 类型 描述
CreateTime String

创建时间


示例值:2026-05-27 11:44:28
Creator String

创建者


示例值:100020293116
IsActive Boolean

是否生效


示例值:true
TotalParam Integer

总参数


示例值:0
Version String

版本号


示例值:2026052757

AIGWMCPToolVersionList

分页查询返回的mcp tool version列表

被如下接口引用:DescribeCloudNativeAPIGatewayMCPToolVersionList。

名称 类型 描述
MCPToolVersions Array of AIGWMCPToolVersion

mcp. tool 版本详情

TotalCount Integer

总数


示例值:5

AIGWMCPUpstreamInfo

云原生网关MCP后端信息,用于创建、修改请求

被如下接口引用:CreateCloudNativeAPIGatewayMCPServer, ModifyCloudNativeAPIGatewayMCPServer。

名称 类型 必选 描述
SourceId String 否

注册中心来源ID


示例值:ins-2c6758fb
Namespace String 否

命名空间


示例值:public
MCPServerId String 否

MCP服务 id


示例值:06d46e56-ff98-4745-861d-66f61742e3fd
Protocol String 否

协议,UpstreamType是Registry 时必传

  • http
  • https

示例值:https
Host String 否

域名或ip


示例值:api.gitee.com
Port Integer 否

端口


示例值:443
ServiceId String 否

服务 id


示例值:4e141ac6-f0cd-4d35-80f0-75e47f5d56a6
ServiceGroup String 否

服务分组


示例值:mcp-server
MCPEndpoint String 否

mcp endpoint


示例值:/mcp
MessageEndpoint String 否

message端点路径,SSE协议时配置


示例值:/message
TLSConfig AIGWUpstreamTLSConfig 否

TLS认证配置

AIGWMCPUpstreamInfoDetail

云原生网关MCP后端信息,用于展示

被如下接口引用:DescribeCloudNativeAPIGatewayMCPServer。

名称 类型 必选 描述
SourceId String 否

注册中心来源ID


示例值:ins-2c6758fb
SourceName String 否

注册中心来源名称, 入参不传,用于返回


示例值:jensonzheng-mcp
Namespace String 否

命名空间


示例值:public
MCPServerId String 否

服务 id


示例值:06d46e56-ff98-4745-861d-66f61742e3fd
Protocol String 否

协议,UpstreamType是Registry 时必传

  • http
  • https

示例值:https
Host String 否

域名或ip


示例值:api.gitee.com
Port Integer 否

端口


示例值:443
ServiceId String 否

服务 id


示例值:4e141ac6-f0cd-4d35-80f0-75e47f5d56a6
ServiceName String 否

服务名字


示例值:dev
ServiceGroup String 否

服务分组


示例值:mcp-server
MCPEndpoint String 否

mcp endpoint


示例值:/mcp
MessageEndpoint String 否

SSE message路径


示例值:/message
TLSConfig AIGWUpstreamTLSConfig 否

TLS配置

AIGWModelRewriteRule

模型名字重写规则

被如下接口引用:CreateCloudNativeAPIGatewayLLMModelService, DescribeCloudNativeAPIGatewayLLMModelService, DescribeCloudNativeAPIGatewayLLMModelServices, ModifyCloudNativeAPIGatewayLLMModelService。

名称 类型 必选 描述
SourceModel String 否

原始模型


示例值:qwen3.5
TargetModel String 否

目标模型


示例值:deepseek-v4-flash

AIGWModelScope

AI网关模型可用范围

被如下接口引用:DescribeCloudNativeAPIGatewayLLMModelAPI。

名称 类型 必选 描述
ScopeType String 否

范围类型

枚举值:

  • ALL: 允许全部访问
  • ALLOWLIST: 允许访问的模型列表
  • MAG: 模型访问组

示例值:MAG
AllowList Array of String 否

允许访问的模型列表,ScopeType=ALLOWLIST时设置


示例值:["deepseek-v4-pro"]
MagRefs Array of String 否

模型访问组,ScopeType=MAG时设置


示例值:["mag-ba1a8bd0bada106d"]

AIGWOAuthAuthPluginConfig

资源端 OAuth2 认证插件配置

被如下接口引用:DescribeCloudNativeAPIGatewayMCPServerAuth, ModifyCloudNativeAPIGatewayMCPServerAuth。

名称 类型 必选 描述
HeaderNames Array of String 否

取token的头部名称


示例值:["header"]
TokenExpiration Integer 否

过期时间


示例值:1220
Scopes Array of String 否

授权范围


示例值:["scope"]
MandatoryScope Boolean 否

是否强制判断授权范围


示例值:true

AIGWOAuthCredentialConfig

OAuth2 凭证物料配置

被如下接口引用:CreateCloudNativeAPIGatewaySecretKey, DescribeCloudNativeAPIGatewaySecretKey, DescribeCloudNativeAPIGatewaySecretKeyList。

名称 类型 必选 描述
ClientId String 是

OAuth2 client_id


示例值:96d9f101-ada5-414c-b768-****
ClientSecret String 是

OAuth2 client_secret


示例值:****
RedirectURIs String 否

OAuth2 授权回调地址


示例值:http://example.com

AIGWOIDCAuthPluginConfig

资源端 OIDC 认证插件配置

被如下接口引用:DescribeCloudNativeAPIGatewayMCPServerAuth, ModifyCloudNativeAPIGatewayMCPServerAuth。

名称 类型 必选 描述
Audience String 否

目标受众


示例值:audience
BearerOnly Boolean 否

是否BearerOnly

目前只能为true


示例值:true
Scopes Array of String 否

授权范围


示例值:["scope"]
ConsumerClaim String 否

消费者标识


示例值:claim
Realm String 否

认证域


示例值:realm
Timeout Integer 否

超时时间


示例值:100
TokenEndpointAuthMethod String 否

令牌端点认证方法

枚举值:

  • client_secret_post: client_secret_post
  • client_secret_basic: client_secret_basic
  • private_key_jwt: private_key_jwt

示例值:client_secret_post
IntrospectionEndpoint String 否

令牌内省端点


示例值:http://example.com/introspection
IntrospectionEndpointAuthMethod String 否

令牌内省端点认证方法

枚举值:

  • client_secret_basic: client_secret_basic
  • client_secret_post: client_secret_post

示例值:client_secret_basic
IssuerURL String 否

签发者地址


示例值:http://example.com/oidc
ClientId String 否

客户端 ID


示例值:client_id
ClientSecret String 否

客户端密钥


示例值:client_secret

AIGWOIDCCredentialConfig

OIDC 凭证物料配置

被如下接口引用:CreateCloudNativeAPIGatewaySecretKey, DescribeCloudNativeAPIGatewaySecretKey, DescribeCloudNativeAPIGatewaySecretKeyList。

名称 类型 必选 描述
ClientId String 是

IdP 注册的 client_id


示例值:aigw-oidc-test
ClientSecret String 是

IdP 注册的 client_secret


示例值:****
IssuerURL String 是

IdP Issuer URL


示例值:*
ConsumerClaimValue String 否

IdP 中该用户的 claim 值


示例值:aigw-oidc-test

AIGWQueryParamCredentialConfig

AI网关 Query Param 凭证物料配置

被如下接口引用:CreateCloudNativeAPIGatewaySecretKey, DescribeCloudNativeAPIGatewaySecretKey, DescribeCloudNativeAPIGatewaySecretKeyList。

名称 类型 必选 描述
ParamName String 否

参数名


示例值:api_key
ParamValue String 否

参数值


示例值:my-query-***

AIGWQuota

AI网关配额

被如下接口引用:DescribeCloudNativeAPIGatewayAIQuotaList。

名称 类型 必选 描述
Id String 否

Id


示例值:c4db7b5c-6de3-4597-a03f-b3ee9de5be2d
ResourceType String 否

资源类型

枚举值:

  • Consumer: 消费者

示例值:Consumer
ResourceId String 否

资源 id


示例值:71a775c5-e634-41ad-b329-15f6eac47f33
ResourceName String 否

资源名字

如消费者名字


示例值:j****t
QuotaType String 否

配额类型

枚举值:

  • RequestCount: 请求数
  • TotalToken: 总 token
  • Cost: 成本

示例值:RequestCount
PeriodUnit String 否

配额周期单位

枚举值:

  • Day: 天
  • Week: 周
  • Month: 月

示例值:Day
QuotaLimit Integer 否

配额


示例值:10
Enabled Boolean 否

启用


示例值:true
CreateTime String 否

创建时间

参数格式:YYYY-MM-DD hh:mm:ss


示例值:2026-05-13 15:49:29
ModifyTime String 否

更新时间

参数格式:YYYY-MM-DD hh:mm:ss


示例值:2026-05-13 16:27:20
Source String 否

配额类型,手动配额还是默认配额


示例值:Manual
ExceedAction String 否

配额超限行为

枚举值:

  • Reject: 拒绝请求
  • AllowOverage: 允许超支

示例值:Reject
CacheHitStat String 否

缓存是否计入限额

枚举值:

  • Full: 全量计入
  • Exclude: 不计入网关缓存命中部分

示例值:Full

AIGWQuotaDetail

AI 网关配额详情

被如下接口引用:DescribeCloudNativeAPIGatewayAIQuota。

名称 类型 必选 描述
Id String 否

id


示例值:c4db7b5c-6de3-4597-a03f-b3ee9de5be2d
ResourceType String 否

资源类型

枚举值:

  • Consumer: 消费者

示例值:Consumer
ResourceId String 否

资源id


示例值:71a775c5-e634-41ad-b329-15f6eac47f33
ResourceName String 否

资源名字


示例值:jenson-prod
QuotaType String 否

配额类型

枚举值:

  • RequestCount: 请求数
  • TotalToken: token总数
  • Cost: 成本

示例值:RequestCount
PeriodUnit String 否

配额单位

枚举值:

  • Day: 天
  • Week: 周
  • Month: 月

示例值:Day
QuotaLimit Integer 否

配额

如果是成本则数值单位是分,如 1000 表示 10.00 元


示例值:10
Enabled Boolean 否

启用


示例值:true
Used Integer 否

用量


示例值:-1
UsageRate Float 否

使用率


示例值:-1
AlarmLevel String 否

预警级别

枚举值:

  • Normal: 正常
  • Warning: 预警
  • NearLimit: 临近超限
  • Exceeded: 超限

示例值:Exceeded
Source String 否

配额规则来源

枚举值:

  • Manual: 手动配置
  • Default: 默认配额

示例值:Manual
ExceedAction String 否

配额超限行为

枚举值:

  • Reject: 拒绝请求
  • AllowOverage: 允许超支

示例值:Reject
CreateTime String 否

创建时间

参数格式:YYYY-MM-DD hh:mm:ss


注意:此字段可能返回 null,表示取不到有效值。
示例值:2026-05-13 15:49:29
ModifyTime String 否

更新时间

参数格式:YYYY-MM-DD hh:mm:ss


注意:此字段可能返回 null,表示取不到有效值。
示例值:2026-05-13 16:27:20
CacheHitStat String 否

缓存是否计入限额

枚举值:

  • Full: 全量计入
  • Exclude: 不计入网关缓存命中部分

示例值:Full

AIGWQuotaList

AI网关配额列表

被如下接口引用:DescribeCloudNativeAPIGatewayAIQuotaList。

名称 类型 必选 描述
TotalCount Integer 否

总数


示例值:1
DataList Array of AIGWQuota 否

配额列表

AIGWRedisConfig

精确缓存 redis 配置

被如下接口引用:CreateCloudNativeAPIGatewayMCPServer, ModifyCloudNativeAPIGatewayMCPServer。

名称 类型 必选 描述
Host String 否

Host


示例值:10.0.2.193
Port Integer 否

端口


示例值:6379
Username String 否

用户名


示例值:aigw
Password String 否

密码


示例值:Tsf123456+
RedisConfigId String 否

Redis配置ID


示例值:redis-config-abc123
Type String 否

Redis部署类型,如standalone(单机)、cluster(集群)


示例值:standalone

AIGWRerankMaxDocumentsConfig

AI 网关Rerank场景最大文档数限制配置

被如下接口引用:CreateCloudNativeAPIGatewayLLMModelAPI, DescribeCloudNativeAPIGatewayLLMModelAPI, ModifyCloudNativeAPIGatewayLLMModelAPI。

名称 类型 必选 描述
EnableMaxDocuments Boolean 是

启用最大文档数限制


示例值:true
MaxDocumentValue Integer 否

Rerank场景最大文档数限制


示例值:2

AIGWRouteModelServiceConfig

AI 网关指定模型路由(暂时只用在Token长度路由时的子路由选择)

被如下接口引用:CreateCloudNativeAPIGatewayLLMModelAPI, ModifyCloudNativeAPIGatewayLLMModelAPI。

名称 类型 必选 描述
ModelServiceName String 否

模型服务名字


示例值:th-gz

AIGWSensitiveWordRoute

AI GW Sensitive Word Route

被如下接口引用:CreateCloudNativeAPIGatewayLLMModelAPI, DescribeCloudNativeAPIGatewayLLMModelAPI, ModifyCloudNativeAPIGatewayLLMModelAPI。

名称 类型 必选 描述
Enabled Boolean 否

是否开启


示例值:true
ModelServiceRefs Array of String 否

模型API ID列表


示例值:["a6ac4163b6544e1eb95c7bc422c32b1b"]
ModelServiceNames Array of String 否

查询接口会返回模型API的Name列表


示例值:["backup-service"]
SelectedTypes Array of String 否

路由方式

枚举值:

  • Weighted: 权重路由
  • ModelName: 按模型名称路由

示例值:["Weighted"]
WeightedConfig Array of CloudNativeAPIGatewayLLMModelServiceRouteWeightedStrategy 否

权重路由配置

ModelNameConfig Array of CloudNativeAPIGatewayLLMModelServiceRouteModelNameStrategy 否

路由名称路由配置

AIGWSimpleSecretKey

简单密钥信息

被如下接口引用:DescribeCloudNativeAPIGatewaySecretKey, DescribeCloudNativeAPIGatewaySecretKeyList。

名称 类型 必选 描述
SecretKeyId String 否

密钥ID


示例值:secret-56537c1ca1d039
Name String 否

密钥名称


示例值:nogood
Status String 否

启用状态

枚举值:

  • Enable: 启动
  • Disable: 禁用

示例值:Disable
SecretType String 否

密钥类型

枚举值:

  • ApiKey: ApiKey类型

示例值:ApiKey
CreateTime String 否

创建时间

参数格式:2026-09-03 14:11:05


示例值:2026-09-03 14:11:05

AIGWTagFilter

AI网关标签过滤

被如下接口引用:CreateCloudNativeAPIGatewayLLMModelAPI, DescribeCloudNativeAPIGatewayLLMModelAPI, ModifyCloudNativeAPIGatewayLLMModelAPI。

名称 类型 必选 描述
MatchStrategy String 否

匹配策略

枚举值:

  • AND: 并
  • OR: 或

示例值:OR
Tags Array of String 否

标签


示例值:["env:dev"]

AIGWTokenLengthRoute

AI 网关token长度路由配置

被如下接口引用:CreateCloudNativeAPIGatewayLLMModelAPI, ModifyCloudNativeAPIGatewayLLMModelAPI。

名称 类型 必选 描述
DefaultEncodingName String 否

默认tokenizer编码器

枚举值:

  • o200k_base: OpenApi o200k_base
  • cl100k_base: OpenApi cl100k_base
  • p50k_base: OpenApi p50k_base
  • r50k_base: OpenApi r50k_base

示例值:o200k_base
DefaultTarget AIGWLLMModelServiceSubRoute 否

token 计数失败、规则为空或未命中任何规则时执行的默认二级路由(暂时只能选择一个指定模型路由)

Rules Array of AIGWTokenLengthRouteRule 否

规则

AIGWTokenLengthRouteRule

AI 网关Token长度路由规则

被如下接口引用:CreateCloudNativeAPIGatewayLLMModelAPI, ModifyCloudNativeAPIGatewayLLMModelAPI。

名称 类型 必选 描述
MinTokenLength Integer 是

token 长度下界,闭区间;0 合法


示例值:0
MaxTokenLength Integer 是

token 长度上界,闭区间


示例值:1
Target AIGWLLMModelServiceSubRoute 是

命中该分段后执行的二级路由

AIGWTopConsumersItem

最高Token用量消费者

被如下接口引用:DescribeCloudNativeAPIGatewayLLMTokenUsageStatistics。

名称 类型 描述
ConsumerId String

消费者Id


示例值:02b4d312-2fcd-4995-ae7c-5acaa57962b7
ConsumerName String

消费者名称


示例值:test-consumer-2
TotalTokens Integer

该消费者花费的Token数


示例值:6705

AIGWUpstreamTLSConfig

AI网关Upstream TLS配置

被如下接口引用:CreateCloudNativeAPIGatewayMCPServer, DescribeCloudNativeAPIGatewayMCPServer, ModifyCloudNativeAPIGatewayMCPServer。

名称 类型 必选 描述
TLSVerify Boolean 否

是否校验上游服务端证书

默认值:false


示例值:true
ClientCertId String 否

客户端证书 ID(mTLS 用)


示例值:bf6ff0bf-737e-49ef-85ab-2ee71c45ac14
UpstreamCACertIds Array of String 否

信任的 CA 证书 ID 列表


示例值:["c4b5d580-1a93-4747-a120-5b6eef6682f7"]

CNAPIGwAIServiceSource

AI服务来源

被如下接口引用:DescribeCloudNativeAPIGatewayAIServiceSourceList。

名称 类型 必选 描述
SourceName String 是

服务来源


示例值:PrivateDNS
SourceId String 是

服务ID


示例值:PrivateDNS
SourceType String 是

来源类型


示例值:DNS
SourceProduct String 是

来源产品


示例值:PrivateDNS
SourceInfo CNAPIGwAIServiceSourceInfo 是

来源配置信息

Description String 否

描述


示例值:testtest
CreateTime String 否

创建时间


示例值:2026-04-09 19:52:00
UpdateTime String 否

更新时间


示例值:2026-04-09 20:10:06

CNAPIGwAIServiceSourceAuth

AI的服务来源授权信息

被如下接口引用:CreateCloudNativeAPIGatewayAIServiceSource, ModifyCloudNativeAPIGatewayAIServiceSource。

名称 类型 必选 描述
Username String 否

账号


示例值:username
Password String 否

密码


示例值:password
AccessToken String 否

接入Token


示例值:4WP8QPLSSehTQmGwOYaVyut2q1zfw2176Xxgv7XV6CqF****

CNAPIGwAIServiceSourceInfo

AI 的服务来源配置信息

被如下接口引用:CreateCloudNativeAPIGatewayAIServiceSource, DescribeCloudNativeAPIGatewayAIServiceSourceList, ModifyCloudNativeAPIGatewayAIServiceSource。

名称 类型 必选 描述
InstanceId String 否

服务来源实例id


示例值:inc-a2af234
Auth CNAPIGwAIServiceSourceAuth 否

授权信息

Addresses Array of String 否

地址列表


示例值:["183.60.83.19"]

CNAPIGwAIServiceSourceList

AI数据源列表

被如下接口引用:DescribeCloudNativeAPIGatewayAIServiceSourceList。

名称 类型 必选 描述
DataList Array of CNAPIGwAIServiceSource 否

MCP服务列表

TotalCount Integer 否

总数


示例值:1

CNAPIGwConsumer

消费者结构

被如下接口引用:DescribeCloudNativeAPIGatewayConsumer。

名称 类型 必选 描述
ConsumerId String 是

消费者 ID。


示例值:consumer-xxx
Name String 是

名字


示例值:消费者名称
CreateTime String 是

创建时间


示例值:2023-01-01 10:00:00
ModifyTime String 是

更新时间 yyyy-MM-dd hh:mm:ss


示例值:2023-01-01 10:00:00
Priority String 否

消费者优先级

枚举值:

  • High: 高优
  • Medium: 中优
  • Low: 低优

示例值:High
Description String 否

描述


注意:此字段可能返回 null,表示取不到有效值。
示例值:消费者描述
ConsumerGroups Array of CNAPIGwConsumerGroup 否

消费者分组


注意:此字段可能返回 null,表示取不到有效值。
SyncStatus String 否

同步状态

枚举值:

  • Fail: 失败

示例值:Fail
SourceType String 否

资源类型

枚举值:

  • ModelService: 模型服务
  • Consumer: 消费者
  • SecretKey: 密钥

示例值:Private
SyncedVersion String 否

同步版本


示例值:v1

CNAPIGwConsumerGroup

消费者组结构

被如下接口引用:DescribeCloudNativeAPIGatewayConsumer, DescribeCloudNativeAPIGatewayConsumerGroup。

名称 类型 必选 描述
ConsumerGroupId String 是

分组id


示例值:cg-xxx
Name String 是

名字


示例值:消费者组名称
Status String 是

状态Disable/Enable


示例值:Enable
Description String 是

描述


示例值:消费者组描述
CreateTime String 否

创建时间


示例值:2023-01-01 10:00:00
ModifyTime String 否

更新时间 yyyy-MM-dd hh:mm:ss


示例值:2023-01-01 10:00:00
BindCount Integer 否

绑定的消费者数量


注意:此字段可能返回 null,表示取不到有效值。
示例值:0
SyncStatus String 否

同步状态

枚举值:

  • Fail: 失败
  • Succes: 成功

示例值:Waiting
SourceType String 否

资源类型

枚举值:

  • Public: 公共
  • Private: 私有
  • SourceDeleted: 资源已删除

示例值:Private
SyncedVersion String 否

同步版本


示例值:v2

CNAPIGwCreateCommonResult

创建资源通用结果

被如下接口引用:CreateCloudNativeAPIGatewayAIServiceSource, CreateCloudNativeAPIGatewayConsumer, CreateCloudNativeAPIGatewayConsumerGroup, CreateCloudNativeAPIGatewayMCPServer, CreateCloudNativeAPIGatewayMCPTool, CreateCloudNativeAPIGatewaySecretKey。

名称 类型 必选 描述
ID String 否 对应的id 值
示例值:consumer-xxx
Success Boolean 否 是否成功
示例值:true

CNAPIGwMCPTool

MCP Tool 信息

被如下接口引用:DescribeCloudNativeAPIGatewayMCPToolList, UpdateCloudNativeAPIGatewayMCPTools。

名称 类型 必选 描述
Name String 是

名字


示例值:createPet7
DisplayName String 是

展示名字


示例值:createPet7
Method String 是

方法

枚举值:

  • GET: GET
  • POST: POST
  • PUT: PUT
  • DELETE: DELETE
  • PATCH: PATCH

示例值:POST
Description String 是

描述


示例值:创建订单
ToolId String 否

工具 id


示例值:3aab6316-69bb-4610-b10c-479c9320f1b0
ContentType String 否

报文格式


示例值:application/json
ServiceId String 否

服务 id


注意:此字段可能返回 null,表示取不到有效值。
示例值:4e141ac6-f0cd-4d35-80f0-75e47f5d56a6
Path String 否

路径


示例值:/api/orders
InputParams Array of CNAPIGwMCPToolParam 否

参数

CreateTime String 否

创建时间

参数格式:yyyy-MM-dd hh:mm:ss


示例值:2026-04-15 17:44:41
UpdateTime String 否

更新时间

参数格式:yyyy-MM-dd hh:mm:ss


示例值:2026-04-15 17:46:32
Status String 否

tool状态

枚举值:

  • Enable: 启用
  • Disable: 禁用

示例值:Enable
CurrentVersion String 否

当前版本号


示例值:default

CNAPIGwMCPToolImportResult

MCP Tools的导入结果

被如下接口引用:DescribeCloudNativeAPIGatewayMCPToolImportTask。

名称 类型 描述
FailedMessage String

导入失败的原因信息


注意:此字段可能返回 null,表示取不到有效值。
示例值:failed to get or create Kong service for VirtualMCPServer, all tools import failed
Method String

请求方法


示例值:POST
Name String

MCP Tool 名字


示例值:createPet7
Path String

MCP Tool的请求路径


示例值:/anything
Status String

导入结果

枚举值:

  • Waiting: 等待导入
  • Success: 导入成功
  • Failed: 导入失败

示例值:Failed
UpstreamUrl String

虚拟MCP Server的Tool的完整后端地址


注意:此字段可能返回 null,表示取不到有效值。
示例值:https://httpbin.org/anything

CNAPIGwMCPToolImportTaskResult

MCP Tools导入任务的进度

被如下接口引用:DescribeCloudNativeAPIGatewayMCPToolImportTask。

名称 类型 描述
FailedCount Integer

导入失败的数量


示例值:0
ProcessedCount Integer

已处理导入Tool的总数


示例值:1
SuccessCount Integer

成功导入的Tool数量


示例值:1
TaskEndTime String

任务结束时间


注意:此字段可能返回 null,表示取不到有效值。
示例值:2026-04-15 16:19:26
TaskId String

任务ID


示例值:task-c93d9ca5
TaskStartTime String

任务开始时间


注意:此字段可能返回 null,表示取不到有效值。
示例值:2026-04-15 16:19:22
TaskStatus String

任务状态

枚举值:

  • Running: 运行中
  • End: 结束

示例值:End
ToolsImportResult Array of CNAPIGwMCPToolImportResult

导入结果详情

TotalCount Integer

待导入Tools的总数


示例值:1

CNAPIGwMCPToolList

MCP Tool 列表

被如下接口引用:DescribeCloudNativeAPIGatewayMCPToolList。

名称 类型 必选 描述
DataList Array of CNAPIGwMCPTool 否

MCPTool 列表

TotalCount Integer 否

总数


示例值:1

CNAPIGwMCPToolParam

MCP tool 参数

被如下接口引用:DescribeCloudNativeAPIGatewayMCPToolsFromFile, ModifyCloudNativeAPIGatewayMCPTool, UpdateCloudNativeAPIGatewayMCPTools。

名称 类型 必选 描述
Name String 是

名字


示例值:tag
Type String 是

参数类型

枚举值:

  • string: 字符串
  • number: 数字
  • boolean: 布尔
  • array: 数组
  • object: 对象

示例值:number
Required Boolean 是

必填


示例值:true
Position String 是

位置

枚举值:

  • query: query
  • path: query
  • header: header
  • body: body

示例值:query
Description String 否

描述


示例值:Pet name
Default String 否

默认值


示例值:20
Items CNAPIGwMCPToolParam 否

数组子项

Properties Array of CNAPIGwMCPToolParam 否

对象属性

BackendName String 否

转发到后端的名称

不填则使用原始名称


示例值:city

CNAPIGwMCPToolPreview

通过OpenAPI文件导入MCP tools的预览内容

被如下接口引用:DescribeCloudNativeAPIGatewayMCPToolsFromFile。

名称 类型 描述
ContentType String

MCP Tool入参的ContentType

枚举值:

  • application/json: json格式
  • application/x-www-form-urlencoded: 表单格式

示例值:application/json
Description String

MCP Tool的描述


注意:此字段可能返回 null,表示取不到有效值。
示例值:List all pets
InputParams Array of CNAPIGwMCPToolParam

MCP Tool的参数

Method String

MCP Tool的请求方法


示例值:GET
Name String

MCP Tool名字


示例值:listPets
Path String

MCP Tool的请求路径


示例值:/pets
Status String

MCP Tool的状态

枚举值:

  • Valid: 可导入
  • Invalid: 不可导入

示例值:invalid
StatusMessage String

不可导入的原因


注意:此字段可能返回 null,表示取不到有效值。
示例值:parameter nesting depth exceeds the maximum of 3 levels
UpstreamUrl String

虚拟MCP Server的tools的完整url路径


注意:此字段可能返回 null,表示取不到有效值。
示例值:http://petstore.example.com/v1/pets

CNAPIGwParseMCPToolsResult

DescribeCloudNativeAPIGatewayMCPToolsFromFile接口的出参

被如下接口引用:DescribeCloudNativeAPIGatewayMCPToolsFromFile。

名称 类型 描述
DataList Array of CNAPIGwMCPToolPreview

MCP Tools列表

TotalCount Integer

MCP tools的数量


示例值:1

CNAPIGwSecretKey

密钥信息

被如下接口引用:DescribeCloudNativeAPIGatewaySecretKey, DescribeCloudNativeAPIGatewaySecretKeyList。

名称 类型 必选 描述
BindCount Integer 否

绑定数


示例值:0
CanBind Boolean 否

是否可以绑定


注意:此字段可能返回 null,表示取不到有效值。
示例值:true
CreateTime String 否

创建时间


示例值:2025-11-11 11:11:11
Description String 否

描述


注意:此字段可能返回 null,表示取不到有效值。
示例值:密钥描述
GenerateType String 否

密钥生成方式。

枚举值:

  • System: 系统自动生成
  • Custom: 用户自定义
  • KMS: 使用 KMS 密钥

示例值:KMS
JWTCredentialConfig AIGWJWTCredentialConfig 否

JWT凭证配置

KmsKeyName String 否

KMS凭证名字


注意:此字段可能返回 null,表示取不到有效值。
示例值:name
KmsKeyVersion String 否

KMS凭证版本


注意:此字段可能返回 null,表示取不到有效值。
示例值:value
ModifyTime String 否

修改时间


示例值:2025-11-11 11:11:11
Name String 否

密钥名字


示例值:name
OAuthCredentialConfig AIGWOAuthCredentialConfig 否

OAuth2凭证配置

OIDCCredentialConfig AIGWOIDCCredentialConfig 否

OIDC凭证配置

Provider String 否

Agent 密钥类型


示例值:Dify
ResourceType String 否

密钥归属资源类型。

枚举值:

  • Consumer: 消费者
  • ModelService: 模型服务

示例值:Consumer
SecretKeyId String 否

密钥id


示例值:secret-xxx
SecretType String 否

密钥协议类型。


示例值:ApiKey
SecretValue String 否

密钥明文


示例值:value
Status String 否

状态。

枚举值:

  • Enable: 启用
  • Disable: 禁用

示例值:Enable
SyncStatus String 否

同步状态

枚举值:

  • Fail: 失败
  • Success: 成功

示例值:Success
SourceType String 否

资源类型

枚举值:

  • Public: 公共
  • Private: 私有
  • SourceDeleted: 资源删除

示例值:Private
SyncedVersion String 否

同步版本


示例值:v1
AKSKCredentialConfig AIGWAKSKCredentialConfig 否

AK/SK凭证配置

CAMCredentialConfig AIGWCAMCredentialConfig 否

CAM凭证配置

BearerTokenCredentialConfig AIGWBearerTokenCredentialConfig 否

Bearer Token凭证配置

BasicCredentialConfig AIGWBasicCredentialConfig 否

Basic Auth凭证配置

CustomHeaderCredentialConfig AIGWCustomHeaderCredentialConfig 否

自定义Header凭证配置

QueryParamCredentialConfig AIGWQueryParamCredentialConfig 否

自定义Query参数凭证配置

BoundModelSecretKeys Array of AIGWSimpleSecretKey 否

该消费者密钥绑定的模型密钥列表

BoundConsumerSecretKeys Array of AIGWSimpleSecretKey 否

绑定了该模型密钥的消费者密钥列表

CNAPIGwSecretKeyList

密钥列表

被如下接口引用:DescribeCloudNativeAPIGatewaySecretKeyList。

名称 类型 必选 描述
SecretKeys Array of CNAPIGwSecretKey 否 密钥列表
TotalCount Integer 否 总数
示例值:1

CloudNativeAPIGatewayLLMModelAPI

LLM 模型 API

被如下接口引用:DescribeCloudNativeAPIGatewayLLMModelAPI, DescribeCloudNativeAPIGatewayLLMModelAPIs。

名称 类型 必选 描述
Id String 否

模型 API ID。


示例值:9006154d87704d3a9e5c839fda1461c1
CreateTime String 否

创建时间


示例值:2026-01-15 10:30:00
ModifyTime String 否

修改时间


示例值:2026-07-28 19:00:00
Name String 否

AI 网关 LLM 模型 API 的唯一标识名称,格式规则:2-50 字符,支持英文、数字、下划线。


示例值:openai_chat
SceneType String 否

选择业务场景,xa0 选项:Chat(聊天)。


示例值:Chat
RequestProtocol String 否

业务场景对应的请求协议,选项:OpenAI(目前只支持 OpenAI)。


示例值:OpenAI
RouteList Array of DefaultKongRoute 否

路由列表

BasePath String 否

为API设置统一的前缀,格式:以/开头,支持字母、数字、短横线。


示例值:/api/v1
StripPath Boolean 否

路径简化,
启用时:客户端请求路径 → 移除Base Path → 后端接收简洁路径
禁用时:客户端请求路径 → 完整传递给后端。


示例值:true
Description String 否

模型 API 的相关描述。


示例值:OpenAI 兼容格式大模型聊天 API
ModelServiceId String 否

模型服务Id


示例值:8006154d87704d3a9e5c839fda1461c1
ModelServiceName String 否

模型服务名称


示例值:openai-service
ModelServiceRoute CloudNativeAPIGatewayLLMModelServiceRoute 否

模型服务路由策略(是指如何路由到模型服务)

MatchHeaders Array of AIGWKVMatch 否

HTTP 请求头匹配规则,用于按请求头路由到不同模型服务。

EnableCrossServiceFallback Boolean 否

是否开启跨服务fallback


示例值:true
CrossServiceFallbackConfig AIGWCrossServiceFallbackConfig 否

跨服务fallback配置详情

DescribeCloudNativeAPIGatewayLLMModelAPI Boolean 否

是否展示模型API


示例值:true
TagFilter AIGWTagFilter 否

标签

LogConfig AIGWLogConfig 否

日志显示相关开关

LogDesensitizeConfig AIGWLogDesensitizeConfig 否

日志脱敏规则

ForwardDesensitizeConfig AIGWForwardDesensitizeConfig 否

转发脱敏规则

MaxDocumentsConfig AIGWRerankMaxDocumentsConfig 否

rerank documents 上限

SensitiveWordRoute AIGWSensitiveWordRoute 否

敏感词路由配置

ConsumerGroupModelScopes Array of AIGWAuthModelScopeItem 否

消费者组模型范围

ConsumerInheritModelScope AIGWConsumerModelScope 否

消费者继承的模型范围

CloudNativeAPIGatewayLLMModelFallbackRule

LLM-单模型内降级规则

被如下接口引用:CreateCloudNativeAPIGatewayLLMModelService, DescribeCloudNativeAPIGatewayLLMModelService, DescribeCloudNativeAPIGatewayLLMModelServices, ModifyCloudNativeAPIGatewayLLMModelService。

名称 类型 必选 描述
FallbackModels Array of String 否 备选模型,主模型不可用时将依次按顺序尝试。
示例值:["gpt-5.1","gpt-5-mini"]

CloudNativeAPIGatewayLLMModelParamCheckInfo

LLM-模型参数检查信息

被如下接口引用:CreateCloudNativeAPIGatewayLLMModelService, DescribeCloudNativeAPIGatewayLLMModelService, DescribeCloudNativeAPIGatewayLLMModelServices, ModifyCloudNativeAPIGatewayLLMModelService。

名称 类型 必选 描述
AllowModelList Array of String 否 允许的模型列表。
示例值:["gpt-5.1","gpt-5-mini"]
ModelValidationFailureStrategy String 否 模型参数校验失败时的处理策略,选项:Return404(返回404)、FallBackToDefaultModel(使用默认模型降级)。
示例值:Return404

CloudNativeAPIGatewayLLMModelService

LLM 模型服务

被如下接口引用:DescribeCloudNativeAPIGatewayLLMModelService, DescribeCloudNativeAPIGatewayLLMModelServices。

名称 类型 必选 描述
Id String 否

模型服务 ID。


示例值:9006154d-8770-xx
Name String 否

模型服务名称。


示例值:openai-test
CreateTime String 否

创建时间。


示例值:2021-09-09 11:52:30
ModifyTime String 否

修改时间。


示例值:2021-09-09 11:52:30
ServiceType String 否

服务类型,目前只支持xa0LLMService。


示例值:LLMService
ModelProvider String 否

选择模型提供商, 选项:OpenAI、Anthropic、Azure OpenAI、自定义HTTP。


示例值:OpenAI
ModelProtocol String 否

API协议标准,根据供应商动态变化:OpenAI→OpenAI/v1,Anthropic→Anthropic/v1等


示例值:OpenAI/v1
UpstreamURL String 否

自定义的模型请求 URL。


示例值:https://api.openai.com/v1
ModelSelector String 否

模型选择方式,选项:Specify(指定模型)、PassThrough(透传请求模型)。


示例值:Specify
DefaultModel String 否

默认模型,模型选择方式为 Specify 时必填。


示例值:gpt-4.1
EnableModelFallback Boolean 否

开启模型降级,模型选择方式为 Specify 时必填。


示例值:true
ModelFallbackRule CloudNativeAPIGatewayLLMModelFallbackRule 否

可以配置备用模型规则,EnableSpecifyModelFallbackxa0为 true 时必填。

EnableModelParamCheck Boolean 否

开启模型参数校验,是否校验客户端传递的 model 参数,xa0模型选择方式为 PassThrough 时必填。


示例值:true
ModelParamCheckRule CloudNativeAPIGatewayLLMModelParamCheckInfo 否

模型检验信息,EnableModelParamCheckxa0为 true 时必填。

Description String 否

描述。


示例值:OpenAI 模型服务
ConnectTimeout Integer 否

连接超时时间

取值范围:[1, 3600000]

单位:毫秒

默认值:10000


示例值:10000
WriteTimeout Integer 否

写入超时时间

取值范围:[1, 3600000]

单位:毫秒

默认值:60000


示例值:60000
ReadTimeout Integer 否

读取超时时间

取值范围:[1, 3600000]

单位:毫秒


示例值:60000
Retries Integer 否

重试次数

取值范围:[0, 5]

单位:次

默认值:0


示例值:0
UpstreamUrlMode String 否

路径拼接模式

枚举值:

  • FixedPath: 固定路径
  • AutoConcat: 自动拼接

示例值:FixedPath
SNI String 否

sni


示例值:generativelanguage.googleapis.com
QuotaLimit AIGWLLMQuotaLimit 否

配额限制

Tags String 否

标签


示例值:["capability:code"]
SecretKeyIds Array of String 否

绑定的模型服务秘钥


示例值:["sk-hjegh"]
ModelRewriteRules Array of AIGWModelRewriteRule 否

模型改写规则

SourceId String 否

服务来源


示例值:cls-****
Namespace String 否

命名空间


示例值:default
ServiceName String 否

服务名称


示例值:mock-openai
Protocol String 否

命名空间


示例值:http
ExtParams Array of KeyValue 否

扩展参数

CustomProviderName String 否

模型自定义供应商名称


示例值:custom-11233
KeyRotationEnabled Boolean 否

是否开启密钥轮转


示例值:true
KeyRotationPeriodDays Integer 否

密钥轮转周期

单位:天


示例值:2
ExternalInstanceId String 否

外部服务来源ID


示例值:ins-test
LoadBalanceConfig AIGWLoadBalanceConfig 否

负载均衡配置。

CanPublish Boolean 否

是否可以发布到广场


示例值:true
PublishStatus String 否

发布状态

枚举值:

  • Unpublished: 未发布
  • Published: 已发布

示例值:Unpublished
SyncStatus String 否

同步状态

枚举值:

  • Success: 成功
  • Fail: 失败

示例值:Waiting
SourceType String 否

资源类型

枚举值:

  • Public: 公共
  • Private: 私有
  • SourceDeleted: 资源删除

示例值:Private
SyncedVersion String 否

同步版本


示例值:v2
Status String 否

模型服务状态

枚举值:

  • Online: 已上线
  • Offline: 已下线
  • Error: 健康检查异常

示例值:Online
EnableHealthCheck Boolean 否

是否启用健康检查


示例值:true
HealthCheck AIGWLLMHealthCheckSetting 否

健康检查配置

CloudNativeAPIGatewayLLMModelServiceRoute

模型服务路由配置

被如下接口引用:CreateCloudNativeAPIGatewayLLMModelAPI, DescribeCloudNativeAPIGatewayLLMModelAPI, ModifyCloudNativeAPIGatewayLLMModelAPI。

名称 类型 必选 描述
SelectedTypes Array of String 是

生效的路由算法类型:权重路由,模型名称路由、参数路由等Weighted/ModelName/Query (预留多个,暂时只能填写一个)


示例值:["ModelName"]
WeightedConfig Array of CloudNativeAPIGatewayLLMModelServiceRouteWeightedStrategy 否

权重路由配置,最多10个

ModelNameConfig Array of CloudNativeAPIGatewayLLMModelServiceRouteModelNameStrategy 否

模型名称路由配置,最多10个

IntentRouteConfig AIGWIntentRoute 否

意图识别

LatencyPriorityConfig AIGWLatencyPriorityConfig 否

延迟路由

CacheAwareRouteConfig AIGWCacheAwareRouteConfig 否

前缀缓存感知路由

TokenLengthRouteConfig AIGWTokenLengthRoute 否

token 长度路

CloudNativeAPIGatewayLLMModelServiceRouteModelNameStrategy

模型服务模型名称路由策略

被如下接口引用:CreateCloudNativeAPIGatewayLLMModelAPI, ModifyCloudNativeAPIGatewayLLMModelAPI。

名称 类型 必选 描述
ModelServiceId String 是

模型服务id


示例值:5b5b32f09bc24278a35541aa450cbbf3
MatchModelName String 是

匹配模型服务


示例值:gen
RewriteModelName String 否

重写模型


示例值:gemini-2.5-flash

CloudNativeAPIGatewayLLMModelServiceRouteWeightedStrategy

权重路由配置

被如下接口引用:CreateCloudNativeAPIGatewayLLMModelAPI, ModifyCloudNativeAPIGatewayLLMModelAPI。

名称 类型 必选 描述
ModelServiceId String 是

模型服务id


示例值:5b5b32f09bc24278a35541aa450cbbf3
Weight Integer 是

权重值


示例值:100

DefaultKongRoute

默认kong路由,目前只在 LLM 模型 API相 关接口使用

被如下接口引用:CreateCloudNativeAPIGatewayLLMModelAPI, DescribeCloudNativeAPIGatewayLLMModelAPI。

名称 类型 必选 描述
Name String 是

服务名字


示例值:test-service
ID String 否

服务ID


示例值:916462a4-8ce4-4605-a7b7-66cd51c38201
Methods Array of String 否

HTTP Method


示例值:["GET"]
Paths Array of String 否

Http Path


示例值:["/v1/users"]

Filter

查询过滤通用对象

被如下接口引用:DescribeCloudNativeAPIGatewayAIQuotaList, DescribeCloudNativeAPIGatewayAIServiceSourceList, DescribeCloudNativeAPIGatewayLLMModelAPIs, DescribeCloudNativeAPIGatewayLLMModelServices, DescribeCloudNativeAPIGatewayLLMTokenUsageList, DescribeCloudNativeAPIGatewayLLMTokenUsageStatistics, DescribeCloudNativeAPIGatewaySecretKeyList。

名称 类型 必选 描述
Name String 是 过滤参数名
示例值:filter-name
Values Array of String 是 过滤参数值
示例值:[]

KVMapping

键值对

被如下接口引用:DescribeCNGWServicesWithRoutes。

名称 类型 必选 描述
Key String 否 键值映射的键
示例值:key
Value String 否 键值映射的值
示例值:value

KeyValue

Key/Value结构

被如下接口引用:CreateCloudNativeAPIGatewayLLMModelService, DescribeCloudNativeAPIGatewayLLMModelService, DescribeCloudNativeAPIGatewayLLMModelServices, ModifyCloudNativeAPIGatewayLLMModelService。

名称 类型 必选 描述
Key String 否 条件的Key
示例值:header
Value String 否 条件的Value
示例值:host

KongRoutePreview

云原生网关路由信息

被如下接口引用:DescribeCNGWServicesWithRoutes。

名称 类型 必选 描述
ID String 是

服务ID


示例值:916462a4-8ce4-4605-a7b7-66cd51c38201
Name String 否

服务名字


示例值:huidu-route
Methods Array of String 否

请求方法列表


注意:此字段可能返回 null,表示取不到有效值。
示例值:["GET"]
Paths Array of String 否

路由Paths列表


注意:此字段可能返回 null,表示取不到有效值。
示例值:["/v1/users"]
Hosts Array of String 否

路由Hosts列表


注意:此字段可能返回 null,表示取不到有效值。
示例值:["tencent.com"]
Protocols Array of String 否

协议列表


示例值:["http"]
PreserveHost Boolean 否

是否保留Host头


示例值:true
HttpsRedirectStatusCode Integer 否

HTTPS重定向状态码


示例值:426
StripPath Boolean 否

是否去除路径前缀


示例值:true
CreatedTime String 否

创建时间


示例值:2024-11-25 10:49:23
ServiceName String 否

服务名


示例值:learn
ServiceID String 否

服务ID


示例值:2a212560-220a-46f6-b139-3238eb8ea041
DestinationPorts Array of Integer 否

目的端口


示例值:[8000]
Headers Array of KVMapping 否

headers

RequestBuffering Boolean 否

是否缓存请求body,默认true


示例值:true
ResponseBuffering Boolean 否

是否缓存响应body,默认true


示例值:true
RegexPriority Integer 否

正则优先级


示例值:0
QueryStringParameters Array of KVMapping 否

querystring参数

RouteSource String 否

路由来源


示例值:Original

KongServicePreview

云原生网关服务预览信息

被如下接口引用:DescribeCNGWServicesWithRoutes。

名称 类型 必选 描述
ID String 是 服务ID
示例值:916462a4-8ce4-4605-a7b7-66cd51c38201
CreatedTime String 否 创建时间
示例值:2024-11-25 10:49:23
Editable Boolean 否 是否可编辑
示例值:true
Name String 否 服务名字
示例值:demo-service
Path String 否 请求路径
注意:此字段可能返回 null,表示取不到有效值。
示例值:/open
Tags Array of String 否 标签
示例值:["demo"]
UpstreamInfo KongUpstreamInfo 否 后端配置
UpstreamType String 否 后端类型
示例值:HostIP

KongServiceRoute

kong实例的服务和路由列表

被如下接口引用:DescribeCNGWServicesWithRoutes。

名称 类型 描述
Service KongServicePreview

服务信息

RouteTotalCount Integer

路由总数


示例值:0
RouteHasMore Boolean

是否还有更多路由


示例值:false
Routes Array of KongRoutePreview

路由列表

KongServiceWithRoutes

返回kong的服务和路由列表

被如下接口引用:DescribeCNGWServicesWithRoutes。

名称 类型 描述
ServiceList Array of KongServiceRoute 服务及路由列表
TotalCount Integer 总数
示例值:0

KongTarget

Kong Upstream中的Target

被如下接口引用:DescribeCNGWServicesWithRoutes。

名称 类型 必选 描述
Host String 是 目标主机地址
示例值:8.8.8.8
Port Integer 是 端口
示例值:100
Weight Integer 是 权重
示例值:10
CreatedTime String 否 创建时间
示例值:2024-11-25 10:49:23
CvmInstanceId String 否 CVM实例ID
示例值:ins-ze3124da
CvmInstanceName String 否 CVM实例名称
示例值:在线学习服务
Health String 否 健康状态
示例值:HEALTHY
Source String 否 Target的来源
示例值:AutoScaling
Tags Array of String 否 target标签
示例值:["learn"]

KongUpstreamInfo

服务的后端配置

被如下接口引用:DescribeCNGWServicesWithRoutes。

名称 类型 必选 描述
Algorithm String 否 负载均衡算法,默认为 round-robin,还支持 least-connections,consisten_hashing
示例值:round-robin
AutoScalingCvmPort Integer 否 CVM弹性伸缩组端口
示例值:80
AutoScalingGroupID String 否 CVM弹性伸缩组ID
示例值:as-4se0czf7
AutoScalingHookStatus String 否 CVM弹性伸缩组生命周期挂钩状态
示例值:Normal
AutoScalingTatCmdStatus String 否 CVM弹性伸缩组使用的CVM TAT命令状态
示例值:Normal
HealthStatus String 否 upstream健康状态HEALTHY(健康), UNHEALTHY(异常), HEALTHCHECKS_OFF(未开启)和NONE(不支持健康检查)
示例值:HEALTHY
Host String 否 IP或域名
示例值:www.example.com
Namespace String 否 命名空间
示例值:Default
Port Integer 否 端口
示例值:80
RealSourceType String 否 精确的服务来源类型,新建服务来源时候传入的类型
示例值:TKE
ScfCamAuthEnable Boolean 否 云函数是否开启CAM鉴权,不填时默认为开启(true)
示例值:true
ScfIsBase64Encoded Boolean 否 云函数是否开启Base64编码,默认为false
示例值:false
ScfIsIntegratedResponse Boolean 否 云函数是否开启响应集成,默认为false
示例值:false
ScfLambdaName String 否 SCF函数名
示例值:helloworld
ScfLambdaQualifier String 否 SCF函数版本
示例值:$LATEST
ScfNamespace String 否 SCF函数命名空间
示例值:Default
ScfType String 否 SCF函数类型
示例值:event
ServiceName String 否 服务(注册中心或Kubernetes中的服务)名字
示例值:demo-service
SlowStart Integer 否 冷启动时间,单位秒
示例值:60
SourceID String 否 服务来源ID
示例值:ins-102555d0
SourceName String 否 服务来源的名字
示例值:tse-polaris
SourceType String 否 服务来源类型
示例值:TKE
Targets Array of KongTarget 否 服务后端类型是IPList时提供
注意:此字段可能返回 null,表示取不到有效值。

ListCloudNativeAPIGatewayLLMModelAPI

LLM 模型 API 列表

被如下接口引用:DescribeCloudNativeAPIGatewayLLMModelAPIs。

名称 类型 描述
TotalCount Integer 总数
示例值:10
DataList Array of CloudNativeAPIGatewayLLMModelAPI AI 网关模型 API 列表。

ListCloudNativeAPIGatewayLLMModelService

LLM 模型服务列表

被如下接口引用:DescribeCloudNativeAPIGatewayLLMModelServices。

名称 类型 描述
TotalCount Integer 模型服务数量。
示例值:3
DataList Array of CloudNativeAPIGatewayLLMModelService 模型服务列表。

ListFilter

列表过滤条件,模糊匹配

被如下接口引用:DescribeCNGWServicesWithRoutes。

名称 类型 必选 描述
Key String 否 过滤字段
示例值:name
Value String 否 过滤值
示例值:user-stu