附录
Model对象定义
AiGwBackendBillingConfigDTO
| 参数名称 |
类型 |
描述 |
| inputTokenPrice |
Double |
输入 Token 单价,允许为 0 表示该维度免费 |
| outputTokenPrice |
Double |
输出 Token 单价,允许为 0 表示该维度免费 |
| cacheTokenPrice |
Double |
缓存 Token 单价,允许为 0 表示该维度免费 |
| priceUnit |
String |
单价计量单位:PER_1K(每千 Token)/PER_1M(每百万 Token) |
AiGwBackendConnectionPoolConfigDTO
| 参数名称 |
类型 |
描述 |
| enabled |
Boolean |
连接池开关,关闭时使用系统默认的连接超时策略,且 tcpKeepalive 配置不生效 |
| idleTimeout |
int |
空闲连接超时时间,单位为秒,取值不小于 1,连接池开关开启时必填 |
| connectTimeout |
int |
连接建立超时时间,单位为秒,取值不小于 1,连接池开关开启时必填 |
| tcpKeepalive |
AiGwBackendTcpKeepaliveConfigDTO |
TCP keepalive 配置,连接池开关开启时必填 |
AiGwBackendDnsServerDTO
| 参数名称 |
类型 |
描述 |
| ip |
String |
DNS 服务器 IP 地址 |
| port |
int |
DNS 服务器端口,取值 1~63355,不传默认 53 |
AiGwBackendGetReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| backendId |
String |
是 |
后端 ID |
AiGwBackendListReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| keyword |
String |
否 |
搜索关键字,与 keywordType 配合使用 |
| keywordType |
String |
否 |
搜索关键字对应的字段名 |
| pageNo |
int |
否 |
页码,从 1 开始,不传默认 1 |
| pageSize |
int |
否 |
每页数据项数目,取值 1~1000,不传默认 1000 |
| order |
String |
否 |
排序方向:asc/desc |
| orderBy |
String |
否 |
排序字段 |
| orders |
List<OrderModel> |
否 |
多字段排序条件,与 order、orderBy 二选一 |
| filters |
List<FilterModel> |
否 |
过滤条件列表 |
| instanceId |
String |
是 |
网关实例 ID |
| name |
String |
否 |
后端名称,模糊匹配 |
| aiModel |
String |
否 |
AI 大模型接口协议:openai/anthropic/raw |
| modelProtocol |
String |
否 |
Model 服务协议:OPENAI_COMPATIBLE/ANTHROPIC_COMPATIBLE/QIANFAN/CUSTOM_HTTP/CUSTOM_WEBSOCKET/DOUBAO/BAILIAN/ORIGINAL |
| backendType |
String |
否 |
后端类型:aiModel(AI 大模型)/ip(固定 IP)/domain(域名)/agent(Agent 服务) |
| apiId |
String |
否 |
路由 ID,按该路由已绑定的后端过滤 |
AiGwBackendTcpKeepaliveConfigDTO
| 参数名称 |
类型 |
描述 |
| enabled |
Boolean |
TCP keepalive 开关,仅连接池开关开启时生效,关闭或不传时不启用 keepalive |
| time |
int |
连接空闲多久后发送探测,单位为秒,取值不小于 1 |
| interval |
int |
两次探测之间的间隔,单位为秒,取值不小于 1 |
| probes |
int |
探测无响应后的重试次数,取值不小于 1 |
AiGwBackendTlsConfigDTO
| 参数名称 |
类型 |
描述 |
| mode |
String |
TLS 模式:DISABLE(关闭 TLS)/SIMPLE(单向 TLS) |
| sni |
String |
SNI 域名,TLS 模式为 SIMPLE 时必填 |
AiGwBackendUO
| 参数名称 |
类型 |
描述 |
| backendId |
String |
后端 ID |
| name |
String |
后端名称 |
| instanceId |
String |
网关实例 ID |
| instanceName |
String |
网关实例名称 |
| backendType |
String |
后端类型:aiModel(AI 大模型)/ip(固定 IP)/domain(域名)/agent(Agent 服务) |
| backendTypeName |
String |
后端类型名称,用于界面展示 |
| aiModel |
String |
AI 大模型接口协议:openai/anthropic/raw,仅后端类型为 aiModel 时返回 |
| aiModelName |
String |
AI 大模型接口协议名称,仅后端类型为 aiModel 时返回 |
| provider |
String |
模型供应商,仅后端类型为 aiModel 时返回 |
| backendServiceEndpoint |
String |
服务地址,格式为 host:port,AI 大模型可再带路径 |
| backendDnsServers |
List<AiGwBackendDnsServerDTO> |
后端专用 DNS 服务器列表,未配置时为空 |
| backendApiKeys |
List<String> |
访问后端使用的 API Key 列表,未配置时为空 |
| billingConfig |
AiGwBackendBillingConfigDTO |
Token 计费配置,用于计算调用该后端产生的 Token 费用,未配置计费时为空 |
| tlsConfig |
AiGwBackendTlsConfigDTO |
访问后端时的 TLS 配置,未启用 TLS 时 mode 为 DISABLE |
| connectionPool |
AiGwBackendConnectionPoolConfigDTO |
访问后端时的连接池配置,未开启时 enabled 为 false 并返回系统默认超时值 |
AiGwListEnumAiModelItemUO
| 参数名称 |
类型 |
描述 |
| baseUrl |
String |
模型服务预置地址,含 http:// 或 https:// |
| aiModel |
String |
AI 大模型接口协议:openai/anthropic/raw |
| backendServiceEndpoint |
String |
由 baseUrl 去掉协议前缀得到的服务地址,格式为 host[:port][/path],可直接作为创建后端的 backendServiceEndpoint 传入,不补全默认端口 |
| tlsConfigMode |
String |
由 baseUrl 协议推导的 TLS 模式:https 为 SIMPLE(单向 TLS),http 为 DISABLE(关闭 TLS) |
| sni |
String |
SNI 域名,取 baseUrl 中的主机名,不含端口与路径,tlsConfigMode 为 DISABLE 时为空 |
AiGwListEnumAiModelUO
| 参数名称 |
类型 |
描述 |
| provider |
String |
模型供应商标识,创建后端时作为 provider 传入 |
| showName |
String |
模型供应商名称,用于界面展示 |
| aiModels |
List<AiGwListEnumAiModelItemUO> |
该供应商支持的接口协议及预置服务地址列表 |
AiGwListEnumBackendTypeUO
| 参数名称 |
类型 |
描述 |
| key |
String |
后端类型标识:aiModel/ip/domain/agent,创建后端时作为 backendType 传入 |
| name |
String |
后端类型名称,用于界面展示 |
| items |
List<AiGwListEnumAiModelUO> |
AI 大模型供应商及接口协议列表,仅后端类型为 AI 大模型时返回,其余类型为空 |
CreateAiGwBackendReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| instanceId |
String |
是 |
网关实例 ID |
| name |
String |
是 |
后端名称 |
| backendType |
String |
是 |
后端类型:aiModel(AI 大模型)/ip(固定 IP)/domain(域名)/agent(Agent 服务) |
| aiModel |
String |
否 |
AI 大模型接口协议:openai/anthropic/raw,仅后端类型为 aiModel 时生效,不传按 openai 处理 |
| provider |
String |
否 |
模型供应商,取值为 custom 或 DescribeBackendTypes 返回的供应商标识,仅后端类型为 aiModel 时生效且必填 |
| backendServiceEndpoint |
String |
是 |
服务地址,格式为 host[:port],AI 大模型可再带路径,不含 http:// 与 https://;省略端口时按 tlsConfig.mode 补全为 80 或 443 |
| backendDnsServers |
List<AiGwBackendDnsServerDTO> |
否 |
后端专用 DNS 服务器列表,最多 5 个,不传表示使用系统默认 DNS |
| backendApiKeys |
List<String> |
否 |
访问后端使用的 API Key 列表,后端类型为 aiModel 时除「provider 为 custom 且 aiModel 为 raw」外必填 |
| billingConfig |
AiGwBackendBillingConfigDTO |
否 |
Token 计费配置,用于计算调用该后端产生的 Token 费用,不传表示不配置计费 |
| tlsConfig |
AiGwBackendTlsConfigDTO |
否 |
访问后端时的 TLS 配置,不传表示不启用 TLS |
| connectionPool |
AiGwBackendConnectionPoolConfigDTO |
否 |
访问后端时的连接池配置,不传表示使用系统默认的连接超时策略 |
CreateAiGwBackendResp
| 参数名称 |
类型 |
描述 |
| backendId |
String |
后端 ID |
DeleteAiGwBackendReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| backendIds |
List<String> |
是 |
待删除的后端 ID 列表 |
FilterModel
| 参数名称 |
类型 |
描述 |
| keyword |
Object |
过滤关键词,取值类型随 keywordType 变化 |
| keywordType |
String |
过滤关键词对应的字段名 |
| subKeywordType |
String |
过滤关键词对应的子字段名 |
ListAiGwBackendUO
| 参数名称 |
类型 |
描述 |
| backendId |
String |
后端 ID |
| name |
String |
后端名称 |
| apiCount |
int |
关联的 API 数量 |
| backendType |
String |
后端类型:aiModel(AI 大模型)/ip(固定 IP)/domain(域名)/agent(Agent 服务) |
| backendTypeName |
String |
后端类型名称,用于界面展示 |
| aiModel |
String |
AI 大模型接口协议:openai/anthropic/raw,仅后端类型为 aiModel 时返回 |
| provider |
String |
模型供应商,仅后端类型为 aiModel 时返回 |
| updateTime |
String |
更新时间,UTC 时间,格式为 yyyy-MM-ddTHH:mm:ssZ |
OrderModel
| 参数名称 |
类型 |
描述 |
| order |
String |
排序方向:asc/desc |
| orderBy |
String |
排序字段 |
| 参数名称 |
类型 |
描述 |
| orderBy |
String |
排序字段 |
| order |
String |
排序方向:asc/desc |
| pageNo |
int |
页码 |
| pageSize |
int |
每页数据项数目 |
| totalCount |
long |
符合条件的数据项总数 |
| result |
List<ListAiGwBackendUO> |
当前页的后端列表 |
UpdateAiGwBackendReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| backendId |
String |
是 |
后端 ID |
| name |
String |
是 |
后端名称 |
| backendType |
String |
否 |
后端类型:aiModel(AI 大模型)/ip(固定 IP)/domain(域名)/agent(Agent 服务),不传表示只更新名称 |
| aiModel |
String |
否 |
AI 大模型接口协议:openai/anthropic/raw,仅后端类型为 aiModel 时生效,不传按 openai 处理 |
| provider |
String |
否 |
模型供应商,取值为 custom 或 DescribeBackendTypes 返回的供应商标识,仅后端类型为 aiModel 时生效且必填 |
| backendServiceEndpoint |
String |
否 |
服务地址,格式为 host[:port],AI 大模型可再带路径,不含 http:// 与 https://;省略端口时按本次请求的 tlsConfig.mode 补全为 80 或 443 |
| backendDnsServers |
List<AiGwBackendDnsServerDTO> |
否 |
后端专用 DNS 服务器列表,最多 5 个,不传表示使用系统默认 DNS |
| backendApiKeys |
List<String> |
否 |
访问后端使用的 API Key 列表,后端类型为 aiModel 时除「provider 为 custom 且 aiModel 为 raw」外必填 |
| billingConfig |
AiGwBackendBillingConfigDTO |
否 |
Token 计费配置,不传表示不修改原有计费配置,传空对象表示清除计费配置 |
| tlsConfig |
AiGwBackendTlsConfigDTO |
否 |
访问后端时的 TLS 配置,不传表示不启用 TLS |
| connectionPool |
AiGwBackendConnectionPoolConfigDTO |
否 |
访问后端时的连接池配置,不传表示使用系统默认的连接超时策略 |
AdvancedPolicyReq
| 参数名称 |
类型 |
描述 |
| timeout |
Boolean |
是否启用超时配置 |
| timeoutTime |
int |
超时时间,单位毫秒 |
| retries |
Boolean |
是否启用重试配置 |
| attempts |
int |
最大重试次数 |
| perTryTimeout |
int |
单次重试超时时间,单位毫秒 |
| retryOn |
List<String> |
重试条件列表 |
| httpCodes |
List<int> |
触发重试的 HTTP 状态码列表 |
说明:仅 MODEL_SERVICE 支持;不传表示不修改,传空对象表示清空。
AiGwApiBackendBindUO
| 参数名称 |
类型 |
描述 |
| backendId |
String |
后端 ID |
| backendName |
String |
后端名称 |
| matchType |
String |
匹配类型 |
| matchContent |
String |
匹配内容 |
| backendRole |
String |
后端角色:PRIMARY/FALLBACK |
| weight |
int |
权重 |
| modelMatchType |
String |
模型名称匹配类型:MODEL_NAME / MODEL_PREFIX / GLOB |
| modelMatchContent |
String |
模型名匹配内容 |
| fallbackOrder |
int |
Fallback 顺序,数值越小越先执行 |
| backendType |
String |
后端类型:aiModel(AI 大模型)/ip(固定 IP)/domain(域名)/agent(Agent 服务) |
| backendTypeName |
String |
后端类型名称,用于界面展示 |
说明:Model 服务默认路由的 upstream/fallback 后端绑定。
AiGwRouteChangePreviewUO
| 参数名称 |
类型 |
描述 |
| apiId |
String |
路由 ID |
| serviceId |
String |
服务 ID |
| routeName |
String |
路由名称 |
| routeSource |
String |
路由来源:CUSTOM/MODEL_SERVICE_DEFAULT/MODEL_SERVICE_MODEL_NAME |
| publishStatus |
String |
发布状态:PUBLISHED/OFFLINE |
| currentPath |
String |
变更前路径 |
| targetPath |
String |
变更后路径 |
| currentUrlRewrite |
Boolean |
变更前是否启用 URL 重写 |
| targetUrlRewrite |
Boolean |
变更后是否启用 URL 重写 |
| currentUrlRewritePath |
String |
变更前重写路径 |
| targetUrlRewritePath |
String |
变更后重写路径 |
| currentUrlRewriteHost |
String |
变更前重写 Host |
| targetUrlRewriteHost |
String |
变更后重写 Host |
| trafficChangeType |
String |
流量变更类型:ADD/MODIFY/DELETE/NONE |
| willPublish |
Boolean |
变更后是否发布 |
AiGwServiceAdvancedPolicyUO
| 参数名称 |
类型 |
描述 |
| timeout |
Boolean |
是否启用超时配置 |
| timeoutTime |
int |
超时时间,单位毫秒 |
| retries |
Boolean |
是否启用重试配置 |
| attempts |
int |
最大重试次数 |
| perTryTimeout |
int |
单次重试超时时间,单位毫秒 |
| retryOn |
List<String> |
重试条件列表 |
| httpCodes |
List<int> |
触发重试的 HTTP 状态码列表 |
说明:Service 级默认高级策略,未配置时返回关闭状态的默认值。
AiGwServiceBoundDomainUO
| 参数名称 |
类型 |
描述 |
| serviceDomainId |
String |
域名 ID |
| domainName |
String |
域名 |
| protocolType |
String |
协议类型:HTTP/HTTPS/BOTH/BOTH_FORCE_HTTPS |
| type |
String |
域名来源:system_public(系统默认公网)/system_private(系统默认私网)/custom(用户自定义) |
说明:用户绑定的自定义域名列表。
AiGwServiceGetReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| serviceId |
String |
是 |
服务 ID |
AiGwServiceListReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| keyword |
String |
否 |
搜索关键字,与 keywordType 配合使用 |
| keywordType |
String |
否 |
搜索关键字对应的字段名 |
| pageNo |
int |
否 |
页码,从 1 开始,不传默认 1 |
| pageSize |
int |
否 |
每页数据项数目,取值 1~1000,不传默认 1000 |
| order |
String |
否 |
排序方向:asc/desc |
| orderBy |
String |
否 |
排序字段 |
| orders |
List<OrderModel> |
否 |
多字段排序条件,与 order、orderBy 二选一 |
| filters |
List<FilterModel> |
否 |
过滤条件列表 |
| instanceId |
String |
是 |
网关实例 ID |
| searchContent |
String |
否 |
服务名称,模糊匹配 |
| serviceType |
String |
否 |
服务类型:HTTP_SERVICE(HTTP 服务)/MODEL_SERVICE(Model 服务)/AGENT_SERVICE(Agent 服务) |
| modelScene |
String |
否 |
模型场景:TEXT_GENERATION/IMAGE_GENERATION/OTHER/VIDEO_GENERATION/EMBEDDING/RERANK/AUDIO |
| modelProtocol |
String |
否 |
Model 服务协议:OPENAI_COMPATIBLE/ANTHROPIC_COMPATIBLE/QIANFAN/CUSTOM_HTTP/CUSTOM_WEBSOCKET/DOUBAO/BAILIAN/ORIGINAL |
AiGwServiceUO
| 参数名称 |
类型 |
描述 |
| serviceId |
String |
服务 ID |
| instanceId |
String |
网关实例 ID |
| serviceName |
String |
服务名称 |
| serviceType |
String |
服务类型:HTTP_SERVICE(HTTP 服务)/MODEL_SERVICE(Model 服务)/AGENT_SERVICE(Agent 服务) |
| modelScene |
String |
模型场景:TEXT_GENERATION/IMAGE_GENERATION/OTHER/VIDEO_GENERATION/EMBEDDING/RERANK/AUDIO |
| modelProtocol |
String |
Model 服务协议:OPENAI_COMPATIBLE/ANTHROPIC_COMPATIBLE/QIANFAN/CUSTOM_HTTP/CUSTOM_WEBSOCKET/DOUBAO/BAILIAN/ORIGINAL |
| modelProtocolRoutes |
List<ModelProtocolRoute> |
Model 服务协议路由列表 |
| modelBasePath |
String |
Model 服务 basePath |
| modelBasePathStrip |
Boolean |
转发时是否剥离 basePath |
| fallbackEnabled |
Boolean |
是否启用 Fallback |
| fallbackFirstTokenTimeoutMs |
int |
Fallback 首 Token 超时时间,单位毫秒 |
| fallbackTriggerScope |
String |
Fallback 触发范围,目前仅支持 BACKEND_ERROR_ONLY |
| advancedPolicy |
AiGwServiceAdvancedPolicyUO |
Service 级默认高级策略,未配置时返回关闭状态的默认值 |
| modelBackends |
List<AiGwApiBackendBindUO> |
Model 服务默认路由的 upstream/fallback 后端绑定 |
| modelBackendStrategy |
String |
Model 服务默认路由后端分流策略:SINGLE/MODEL_NAME/WEIGHT |
| consumerAuthEnabled |
Boolean |
是否开启消费者鉴权 |
| authorizationType |
String |
鉴权类型 |
| apiCount |
int |
服务下路由数量 |
| domainCount |
long |
服务下绑定域名数量 |
| defaultPrivateDomain |
String |
系统默认私网域名 |
| defaultPublicDomain |
String |
系统默认公网域名 |
| domainIds |
List<String> |
已绑定的自定义域名 ID 列表 |
| domains |
List<ListAiGwServiceDomainUO> |
已绑定域名列表 |
| createTime |
String |
创建时间 |
| updateTime |
String |
更新时间 |
CheckServiceNameRepeatedReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| instanceId |
String |
是 |
网关实例 ID |
| serviceName |
String |
是 |
待校验的服务名称 |
CheckServiceNameRepeatedUO
| 参数名称 |
类型 |
描述 |
| serviceNameCanUse |
Boolean |
该服务名称是否可用,true 表示未被占用 |
CreateAiGwServiceReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| instanceId |
String |
是 |
网关实例 ID |
| serviceName |
String |
是 |
服务名称 |
| serviceType |
String |
否 |
服务类型:HTTP_SERVICE(HTTP 服务)/MODEL_SERVICE(Model 服务)/AGENT_SERVICE(Agent 服务) |
| modelScene |
String |
否 |
模型场景:TEXT_GENERATION/IMAGE_GENERATION/OTHER/VIDEO_GENERATION/EMBEDDING/RERANK/AUDIO,仅 MODEL_SERVICE 时生效 |
| modelProtocol |
String |
否 |
Model 服务协议:OPENAI_COMPATIBLE/ANTHROPIC_COMPATIBLE/QIANFAN/CUSTOM_HTTP/CUSTOM_WEBSOCKET/DOUBAO/BAILIAN/ORIGINAL,仅 MODEL_SERVICE 时生效 |
| modelProtocolRoutes |
List<ModelProtocolRouteReq> |
否 |
Model 服务协议路由列表 |
| modelBasePath |
String |
否 |
Model 服务 basePath |
| modelBasePathStrip |
Boolean |
否 |
转发时是否剥离 basePath |
| domainIds |
List<String> |
否 |
绑定的自定义域名 ID 列表 |
| fallbackEnabled |
Boolean |
否 |
是否启用 Fallback |
| fallbackFirstTokenTimeoutMs |
int |
否 |
Fallback 首 Token 超时时间,单位毫秒,取值不小于 0 |
| fallbackTriggerScope |
String |
否 |
Fallback 触发范围,目前仅支持 BACKEND_ERROR_ONLY |
| advancedPolicy |
AdvancedPolicyReq |
否 |
Service 级默认高级策略,仅 MODEL_SERVICE 支持 |
| modelBackendStrategy |
String |
否 |
Model 服务默认路由后端分流策略:SINGLE/MODEL_NAME/WEIGHT |
| modelBackends |
List<ModelBackendBindReq> |
否 |
Model 服务默认路由的 upstream/fallback 后端绑定 |
CreateAiGwServiceResp
| 参数名称 |
类型 |
描述 |
| serviceId |
String |
服务 ID |
DeleteAiGwServiceReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| serviceIds |
List<String> |
是 |
待删除的服务 ID 列表,至少包含 1 个元素 |
DeleteAiGwServiceResp
无特殊参数。
ListAiGwServiceDomainUO
| 参数名称 |
类型 |
描述 |
| serviceDomainId |
String |
域名 ID |
| domainName |
String |
域名 |
| protocolType |
String |
协议类型:HTTP/HTTPS/BOTH/BOTH_FORCE_HTTPS |
| instanceId |
String |
网关实例 ID |
| instanceName |
String |
网关实例名称 |
| serviceId |
String |
服务 ID |
| serviceName |
String |
服务名称 |
| domainType |
String |
域名来源:system_public(系统默认公网)/system_private(系统默认私网)/custom(用户自定义) |
| updateTime |
String |
更新时间 |
说明:已绑定域名列表。
ListAiGwServiceUO
| 参数名称 |
类型 |
描述 |
| serviceId |
String |
服务 ID |
| serviceName |
String |
服务名称 |
| serviceType |
String |
服务类型:HTTP_SERVICE(HTTP 服务)/MODEL_SERVICE(Model 服务)/AGENT_SERVICE(Agent 服务) |
| modelScene |
String |
模型场景:TEXT_GENERATION/IMAGE_GENERATION/OTHER/VIDEO_GENERATION/EMBEDDING/RERANK/AUDIO |
| modelProtocol |
String |
Model 服务协议:OPENAI_COMPATIBLE/ANTHROPIC_COMPATIBLE/QIANFAN/CUSTOM_HTTP/CUSTOM_WEBSOCKET/DOUBAO/BAILIAN/ORIGINAL |
| modelProtocolRoutes |
List<ModelProtocolRoute> |
Model 服务协议路由列表 |
| modelBasePath |
String |
Model 服务 basePath |
| modelBasePathStrip |
Boolean |
转发时是否剥离 basePath |
| modelBackendStrategy |
String |
Model 服务默认路由后端分流策略:SINGLE/MODEL_NAME/WEIGHT |
| apiCount |
int |
服务下路由数量 |
| domainCount |
long |
服务下绑定域名数量 |
| defaultPrivateDomain |
String |
系统默认私网域名 |
| defaultPublicDomain |
String |
系统默认公网域名 |
| domains |
List<AiGwServiceBoundDomainUO> |
用户绑定的自定义域名列表 |
| consumerAuthEnabled |
Boolean |
是否开启消费者鉴权 |
| updateTime |
String |
更新时间 |
ModelBackendBindReq
| 参数名称 |
类型 |
描述 |
| backendId |
String |
后端 ID |
| backendRole |
String |
后端角色:PRIMARY/FALLBACK |
| weight |
int |
权重,取值 0~10000 |
| modelMatchContent |
String |
模型名匹配内容 |
| fallbackOrder |
int |
Fallback 顺序,必须为正整数且同一路由不可重复,数值越小越先执行 |
说明:Model 服务默认路由的 upstream/fallback 后端绑定。
ModelProtocolPresetRouteGroupUO
| 参数名称 |
类型 |
描述 |
| protocol |
String |
Model 服务协议:OPENAI_COMPATIBLE/ANTHROPIC_COMPATIBLE/QIANFAN/CUSTOM_HTTP/CUSTOM_WEBSOCKET/DOUBAO/BAILIAN/ORIGINAL |
| routes |
List<ModelProtocolPresetRouteUO> |
该协议下的预置路由列表 |
ModelProtocolPresetRouteUO
| 参数名称 |
类型 |
描述 |
| id |
String |
路由标识 |
| name |
String |
路由名称 |
| method |
String |
HTTP 方法 |
| path |
String |
路径 |
| support |
Boolean |
是否支持 |
说明:协议预置路由模板列表。
ModelProtocolRoute
| 参数名称 |
类型 |
描述 |
| id |
String |
路由标识 |
| name |
String |
路由名称 |
| enabled |
Boolean |
是否启用 |
| method |
String |
HTTP 方法 |
| path |
String |
路径 |
| matchType |
String |
匹配类型:Exact(精确)/Prefix(前缀)/Regex(正则) |
| matchPath |
String |
实际匹配路径 |
说明:Model 服务协议路由列表。
ModelProtocolRouteReq
| 参数名称 |
类型 |
描述 |
| id |
String |
路由标识 |
| enabled |
Boolean |
是否启用 |
| method |
String |
HTTP 方法 |
| path |
String |
路径 |
说明:Model 服务协议路由列表。
| 参数名称 |
类型 |
描述 |
| orderBy |
String |
排序字段 |
| order |
String |
排序方向:asc/desc |
| pageNo |
int |
页码 |
| pageSize |
int |
每页数据项数目 |
| totalCount |
long |
符合条件的数据项总数 |
| result |
List<ListAiGwServiceUO> |
当前页的服务列表 |
PreviewUpdateAiGwServiceResp
UpdateAiGwServiceReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| serviceId |
String |
是 |
服务 ID |
| serviceName |
String |
是 |
服务名称 |
| serviceType |
String |
否 |
服务类型:HTTP_SERVICE(HTTP 服务)/MODEL_SERVICE(Model 服务)/AGENT_SERVICE(Agent 服务) |
| modelScene |
String |
否 |
模型场景:TEXT_GENERATION/IMAGE_GENERATION/OTHER/VIDEO_GENERATION/EMBEDDING/RERANK/AUDIO,仅 MODEL_SERVICE 时生效 |
| modelProtocol |
String |
否 |
Model 服务协议:OPENAI_COMPATIBLE/ANTHROPIC_COMPATIBLE/QIANFAN/CUSTOM_HTTP/CUSTOM_WEBSOCKET/DOUBAO/BAILIAN/ORIGINAL,仅 MODEL_SERVICE 时生效 |
| modelProtocolRoutes |
List<ModelProtocolRouteReq> |
否 |
Model 服务协议路由列表 |
| modelBasePath |
String |
否 |
Model 服务 basePath |
| modelBasePathStrip |
Boolean |
否 |
转发时是否剥离 basePath |
| modelBackends |
List<ModelBackendBindReq> |
否 |
Model 服务默认路由的 upstream/fallback 后端绑定 |
| modelBackendStrategy |
String |
否 |
Model 服务默认路由后端分流策略:SINGLE/MODEL_NAME/WEIGHT |
| fallbackEnabled |
Boolean |
否 |
是否启用 Fallback |
| fallbackFirstTokenTimeoutMs |
int |
否 |
Fallback 首 Token 超时时间,单位毫秒,取值不小于 0 |
| fallbackTriggerScope |
String |
否 |
Fallback 触发范围,目前仅支持 BACKEND_ERROR_ONLY |
| advancedPolicy |
AdvancedPolicyReq |
否 |
Service 级默认高级策略,仅 MODEL_SERVICE 支持;不传表示不修改,传空对象表示清空 |
| domainIds |
List<String> |
否 |
更新时指定的自定义域名 ID 列表;null 表示保持不变,空列表表示解绑全部自定义域名(系统默认域名保留) |
AiGwServiceDomainListReq
| 参数名称 |
类型 |
描述 |
| keyword |
String |
搜索关键词 |
| keywordType |
String |
关键词类型 |
| pageNo |
int |
页码,从 1 开始 |
| pageSize |
int |
每页返回的记录数 |
| order |
String |
排序方向 |
| orderBy |
String |
排序字段 |
| orders |
List<OrderModel> |
多字段排序设置 |
| filters |
List<FilterModel> |
筛选条件 |
| serviceId |
String |
服务 ID |
| searchContent |
String |
搜索内容,按域名或服务域名 ID 前缀匹配 |
| containsSystem |
Boolean |
是否包含系统默认域名;true:包含,false 或不传:仅返回自定义域名 |
| filterBindingStatus |
Boolean |
绑定状态筛选;true:已绑定,false:未绑定,不传:不过滤 |
BindAiGwServiceDomainReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| serviceId |
String |
是 |
服务 ID |
| domainId |
String |
是 |
服务域名 ID |
CreateAiGwServiceDomainReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| domainName |
String |
是 |
域名 |
| protocolType |
String |
是 |
访问协议:HTTP(仅支持 HTTP)、HTTPS(仅支持 HTTPS)、BOTH(同时支持 HTTP 和 HTTPS)或 BOTH_FORCE_HTTPS(HTTP 强制跳转 HTTPS) |
| certificateId |
String |
否 |
HTTPS 证书 ID;启用 HTTPS 时必填 |
CreateAiGwServiceDomainResp
| 参数名称 |
类型 |
描述 |
| domainId |
String |
已创建的服务域名 ID |
DeleteAiGwServiceDomainReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| domainIds |
List<String> |
是 |
待删除的服务域名 ID 列表 |
DeleteAiGwServiceDomainResp
无特殊参数。
PageResultRespListAiGwServiceDomainUO
| 参数名称 |
类型 |
描述 |
| orderBy |
String |
排序字段 |
| order |
String |
排序方向 |
| pageNo |
int |
页码,从 1 开始 |
| pageSize |
int |
每页返回的记录数 |
| totalCount |
long |
符合条件的记录总数 |
| result |
List<ListAiGwServiceDomainUO> |
当前页的服务域名列表 |
UnbindAiGwServiceDomainReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| domainId |
String |
是 |
要解绑的服务域名 ID |
CreateAgentBackendAndApiResp
| 参数名称 |
类型 |
描述 |
| backendId |
String |
后端 ID |
| apiId |
String |
API ID |
CreateAgentBackendAndApiReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| instanceId |
String |
是 |
网关实例 ID |
| serviceId |
String |
是 |
服务 ID,必须是 Agent 服务 |
| backend |
AgentBackend |
是 |
|
| apiType |
String |
是 |
API 类型 |
| methods |
List<String> |
是 |
请求方法 |
| path |
String |
是 |
路径 |
| matchType |
String |
是 |
匹配类型 |
| urlRewritePath |
String |
否 |
重写后的请求路径;为空时不开启路径重写 |
| urlRewriteType |
String |
否 |
路径重写匹配类型:Exact / Prefix / Regex;不传时按匹配类型推导 |
| urlRewriteRegexMatch |
String |
否 |
正则重写模式,如 ^/user/(+)(/.*)$;重写类型为 Regex 时必填 |
| urlRewriteRegexRewrite |
String |
否 |
正则重写替换表达式,如 /instance/\1;重写类型为 Regex 时必填 |
AgentBackend
| 参数名称 |
类型 |
是否必需 |
描述 |
| backendServiceEndpoint |
String |
是 |
Agent 后端服务地址,格式为 host[:port],省略端口时默认为 80 |
说明:Agent 后端配置
CreateAiGwApiReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| instanceId |
String |
是 |
网关实例 ID |
| serviceId |
String |
是 |
服务 ID |
| apiType |
String |
是 |
API 类型:HTTP/WebSocket API 传 HTTP_ROUTE / WEB_SOCKET,Agent 路由传 http / websocket,Model 路由传 MODEL_ROUTE |
| routeType |
String |
否 |
路由类型:HTTP_ROUTE / MODEL_ROUTE / AGENT_ROUTE,不传时默认为 HTTP_ROUTE |
| modelBackendStrategy |
String |
否 |
后端策略:HTTP/WebSocket API 支持 SINGLE / WEIGHT,Model 路由支持 SINGLE / MODEL_NAME / WEIGHT,Agent 路由不传 |
| name |
String |
是 |
API 名称 |
| description |
String |
否 |
路由描述 |
| methods |
List<String> |
是 |
请求方法 |
| path |
String |
是 |
路径 |
| matchType |
String |
是 |
匹配类型 |
| headerList |
List<AiGwApiHeader> |
否 |
请求头 |
| queryList |
List<AiGwApiQuery> |
否 |
请求参数 |
| backendList |
List<AiGwApiBackendBind> |
是 |
后端配置 |
| urlRewrite |
Boolean |
否 |
路径重写 |
| urlRewritePath |
String |
否 |
路径重写:重写后的路径 |
| urlRewriteHost |
String |
否 |
路径重写:重写后的 Host |
| urlRewriteType |
String |
否 |
路径重写匹配类型:Exact / Prefix / Regex;开启路径重写时必填 |
| urlRewriteRegexMatch |
String |
否 |
正则重写模式,如 ^/user/(+)(/.*)$;重写类型为 Regex 时必填 |
| urlRewriteRegexRewrite |
String |
否 |
正则重写替换表达式,如 /instance/\1;重写类型为 Regex 时必填 |
| retries |
Boolean |
否 |
重试 |
| attempts |
int |
否 |
重试次数 |
| perTryTimeout |
int |
否 |
单次重试超时时间(毫秒) |
| retryOn |
List<String> |
否 |
重试条件 |
| httpCodes |
List<int> |
否 |
触发重试的响应状态码 |
| timeout |
Boolean |
否 |
超时时间 |
| timeoutTime |
int |
否 |
超时时间(毫秒) |
| priorityNumber |
long |
是 |
优先级(0-9999),0 为最高优先级,默认 9999 |
| fallbackEnabled |
Boolean |
否 |
Model 路由 Fallback 开关 |
| fallbackFirstTokenTimeoutMs |
int |
否 |
Model 路由 Fallback 首次响应超时时间(毫秒),0 表示不启用 |
| fallbackTriggerScope |
String |
否 |
Model 路由 Fallback 触发范围,仅支持 BACKEND_ERROR_ONLY |
| consumerAuthEnabled |
Boolean |
否 |
是否开启消费者认证 |
| authorizationType |
String |
否 |
消费者认证方式:API_KEY / AK_SK;开启认证时必填 |
| consumerIds |
List<String> |
否 |
绑定消费者 ID 列表,可为空(开启但空 = 全部拒绝) |
| consumerAuthorizations |
List<ConsumerAuthorization> |
否 |
消费者认证项列表;同一消费者可同时以 API_KEY 和 AK_SK 授权 |
ConsumerAuthorization
| 参数名称 |
类型 |
描述 |
| consumerId |
String |
消费者 ID |
| authorizationType |
String |
认证类型:API_KEY / AK_SK |
说明:消费者认证项列表,同一消费者可同时以 API_KEY 和 AK_SK 授权
AiGwApiBackendBind
| 参数名称 |
类型 |
描述 |
| ruleId |
String |
MODEL_NAME 主后端对应的规则 ID,为空表示新增 |
| backendId |
String |
后端 ID |
| matchType |
String |
匹配类型 |
| matchContent |
String |
匹配内容 |
| backendRole |
String |
后端角色:HTTP/WebSocket API 和 Agent 仅支持 PRIMARY,Model 路由支持 PRIMARY / FALLBACK;不传时默认 PRIMARY |
| weight |
int |
主后端权重,取值 0-10000 |
| modelMatchType |
String |
模型名称匹配类型,仅 Model 路由 MODEL_NAME 策略的 PRIMARY 后端使用:MODEL_NAME / MODEL_PREFIX / GLOB |
| modelMatchContent |
String |
模型名称匹配内容,仅 Model 路由 MODEL_NAME 策略的 PRIMARY 后端使用 |
| fallbackOrder |
int |
Fallback 后端顺序,仅 Model 路由 FALLBACK 使用;须为正整数且同一路由内唯一,数值越小越优先 |
说明:后端配置
AiGwApiQuery
| 参数名称 |
类型 |
描述 |
| queryKey |
String |
查询参数 Key |
| queryValue |
String |
查询参数值 |
| matchType |
String |
匹配类型 |
说明:请求参数列表
| 参数名称 |
类型 |
描述 |
| headerKey |
String |
请求头 Key |
| headerValue |
String |
请求头值 |
| matchType |
String |
匹配类型 |
说明:请求头列表
DeleteAgentBackendAndApiResp
| 参数名称 |
类型 |
描述 |
| apiId |
String |
API ID |
| backendId |
String |
后端 ID |
DeleteAgentBackendAndApiReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| apiId |
String |
是 |
Agent 路由 ID |
DeleteAiGwApiResp
无特殊参数。
DeleteAiGwApiReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| apiIds |
List<String> |
是 |
API ID 列表 |
DeleteMatchRuleResp
无特殊参数。
DeleteMatchRuleReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| logicalRouteId |
String |
是 |
逻辑路由 ID |
| ruleIds |
List<String> |
是 |
匹配规则 ID 列表 |
AiGwApiUO
| 参数名称 |
类型 |
描述 |
| apiId |
String |
API ID |
| logicalRouteId |
String |
逻辑路由 ID |
| instanceId |
String |
实例 ID |
| instanceName |
String |
实例名称 |
| serviceId |
String |
服务 ID |
| serviceName |
String |
服务名称 |
| apiType |
String |
API 类型 |
| routeType |
String |
路由类型:HTTP_ROUTE / MODEL_ROUTE / AGENT_ROUTE |
| routeSource |
String |
路由来源:CUSTOM / MODEL_SERVICE_DEFAULT / MODEL_SERVICE_MODEL_NAME |
| publishStatus |
String |
发布状态:PUBLISHED / OFFLINE |
| advancedPolicy |
AdvancedPolicyVO |
|
| isModelServiceDefaultApi |
Boolean |
是否为 Model 服务自动生成的默认 API |
| name |
String |
API 名称 |
| methods |
List<String> |
请求方法 |
| matchType |
String |
匹配类型 |
| path |
String |
路径 |
| description |
String |
描述 |
| fallbackEnabled |
Boolean |
Model 路由 Fallback 开关 |
| fallbackFirstTokenTimeoutMs |
int |
Model 路由 Fallback 首次响应超时时间(毫秒),0 表示不启用 |
| fallbackTriggerScope |
String |
Model 路由 Fallback 触发范围,仅支持 BACKEND_ERROR_ONLY |
| modelBackendStrategy |
String |
后端策略:HTTP/WebSocket API 支持 SINGLE / WEIGHT,Model 路由支持 SINGLE / MODEL_NAME / WEIGHT,Agent 路由返回 null |
| createTime |
String |
创建时间 |
| updateTime |
String |
修改时间 |
| headerList |
List<AiGwApiHeaderUO> |
请求头列表 |
| queryList |
List<AiGwApiQueryUO> |
查询参数列表 |
| backendList |
List<AiGwApiBackendBindUO> |
后端配置列表,兼容返回 PRIMARY / FALLBACK |
| fallbackBackendList |
List<AiGwApiBackendBindUO> |
Fallback 后端列表,按 fallbackOrder 排序 |
| matchRules |
List<MatchRuleUO> |
逻辑路由匹配规则 |
| urlRewrite |
Boolean |
路径重写 |
| urlRewritePath |
String |
路径重写:重写后的路径 |
| urlRewriteHost |
String |
路径重写:重写后的 Host |
| urlRewriteType |
String |
路径重写匹配类型:Exact / Prefix / Regex |
| urlRewriteRegexMatch |
String |
正则重写模式,仅当重写类型为 Regex 时有值 |
| urlRewriteRegexRewrite |
String |
正则重写替换表达式,仅当重写类型为 Regex 时有值 |
| retries |
Boolean |
重试 |
| attempts |
int |
重试次数 |
| perTryTimeout |
int |
单次重试超时时间(毫秒) |
| retryOn |
List<String> |
重试条件 |
| httpCodes |
List<int> |
触发重试的响应状态码 |
| timeout |
Boolean |
超时时间 |
| timeoutTime |
int |
超时时间(毫秒) |
| priorityNumber |
long |
优先级(0-9999),0 为最高优先级,默认 9999 |
| consumerAuthEnabled |
Boolean |
是否开启消费者认证 |
| authorizationType |
String |
消费者认证方式:API_KEY / AK_SK;未开启为空 |
| consumerAuthorizations |
List<ConsumerAuthorization> |
消费者认证项列表,每项为一个消费者 + 一种凭证类型 |
| serviceConsumerAuthEnabled |
Boolean |
所属服务是否开启消费者认证;API 未开启时继承服务级配置 |
| serviceAuthorizationType |
String |
所属服务的消费者认证方式:API_KEY / AK_SK;服务未开启为空 |
| securityProtection |
AiGwApiSecurityProtectionUO |
API 安全防护配置 |
| plugins |
List<AiGwApiPluginUO> |
当前 API 适用且对用户可见的插件聚合结果,每个插件一条,已按插件顺序排列,包含禁用状态 |
AiGwApiPluginUO
| 参数名称 |
类型 |
描述 |
| pluginId |
String |
插件发布 ID |
| pluginBindingId |
String |
插件绑定 ID,系统默认插件为空 |
| status |
String |
插件绑定状态:Enable / Disable |
| pluginName |
String |
插件名称 |
| pluginType |
String |
插件类型:系统或自定义 |
| pluginPhase |
String |
插件阶段:AUTHN / AUTHZ / STATS |
| executionPriority |
int |
插件执行优先级 |
| executionIndex |
int |
插件展示顺序,从 1 开始 |
| effectiveLevel |
String |
生效级别:Instance / Service / Api |
| inherited |
Boolean |
是否继承自实例或服务 |
| uninstallable |
Boolean |
是否允许在当前 API 下卸载 |
| uninstallDisabledReason |
String |
不可卸载原因 |
| jumpTarget |
JumpTarget |
|
说明:当前 API 适用的插件列表,按插件顺序排列
JumpTarget
| 参数名称 |
类型 |
描述 |
| resourceType |
String |
目标资源类型:INSTANCE / SERVICE |
| resourceId |
String |
目标资源 ID |
说明:继承插件的跳转目标
AiGwApiSecurityProtectionUO
| 参数名称 |
类型 |
描述 |
| enabled |
Boolean |
是否开启消费者授权 |
说明:安全防护状态
MatchRuleUO
| 参数名称 |
类型 |
描述 |
| ruleId |
String |
物理规则 ID |
| routeSource |
String |
路由来源:CUSTOM / CUSTOM_MODEL_NAME / MODEL_SERVICE_DEFAULT / MODEL_SERVICE_MODEL_NAME |
| publishStatus |
String |
发布状态:PUBLISHED / OFFLINE |
| defaultRule |
Boolean |
是否为默认规则 |
| matchExpression |
String |
匹配条件表达式 |
| priorityNumber |
long |
优先级(0-9999),0 为最高优先级 |
| editable |
Boolean |
是否可编辑 |
| deletable |
Boolean |
是否可删除 |
| publishable |
Boolean |
是否可发布 |
| offlinable |
Boolean |
是否可下线 |
| editDisabledReason |
String |
不可编辑原因 |
| deleteDisabledReason |
String |
不可删除原因 |
| modelMatchType |
String |
模型名称匹配类型:MODEL_NAME / MODEL_PREFIX / GLOB |
| modelMatchContent |
String |
模型名称匹配内容 |
| headerList |
List<AiGwApiHeaderUO> |
请求头匹配条件 |
| queryList |
List<AiGwApiQueryUO> |
查询参数匹配条件 |
| backendList |
List<AiGwApiBackendBindUO> |
后端配置列表 |
| updateTime |
String |
修改时间 |
说明:逻辑路由下的匹配规则,按生效顺序返回
AiGwApiQueryUO
| 参数名称 |
类型 |
描述 |
| queryKey |
String |
查询参数 Key |
| queryValue |
String |
查询参数值 |
| matchType |
String |
匹配类型 |
| 参数名称 |
类型 |
描述 |
| headerKey |
String |
请求头 Key |
| headerValue |
String |
请求头值 |
| matchType |
String |
匹配类型 |
AdvancedPolicyVO
| 参数名称 |
类型 |
描述 |
| urlRewrite |
Boolean |
|
| urlRewritePath |
String |
|
| urlRewriteHost |
String |
|
| timeout |
Boolean |
|
| timeoutTime |
int |
|
| retries |
Boolean |
|
| attempts |
int |
|
| perTryTimeout |
int |
|
| retryOn |
List<String> |
|
| httpCodes |
List<int> |
|
说明:API 生效的高级策略
AiGwApiGetReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| apiId |
String |
是 |
API ID |
| 参数名称 |
类型 |
描述 |
| orderBy |
String |
排序字段 |
| order |
String |
排序方向 |
| pageNo |
int |
页码 |
| pageSize |
int |
每页数据项数目 |
| totalCount |
long |
数据总条数 |
| result |
List<ListAiGwApiUO> |
API 列表 |
ListAiGwApiUO
| 参数名称 |
类型 |
描述 |
| apiId |
String |
API ID |
| logicalRouteId |
String |
逻辑路由 ID |
| name |
String |
API 名称 |
| apiType |
String |
API 类型 |
| routeType |
String |
路由类型:HTTP_ROUTE / MODEL_ROUTE / AGENT_ROUTE |
| modelBackendStrategy |
String |
后端策略:SINGLE / MODEL_NAME / WEIGHT |
| backendCount |
int |
主后端数量,不包含 Fallback 后端 |
| routeSource |
String |
路由来源:CUSTOM / MODEL_SERVICE_DEFAULT / MODEL_SERVICE_MODEL_NAME |
| publishStatus |
String |
发布状态:PUBLISHED / OFFLINE |
| serviceId |
String |
服务 ID |
| serviceName |
String |
服务名称 |
| serviceType |
String |
服务类型:HTTP_SERVICE / MODEL_SERVICE / AGENT_SERVICE |
| modelScene |
String |
模型场景:TEXT_GENERATION / IMAGE_GENERATION / OTHER / VIDEO_GENERATION / EMBEDDING / RERANK / AUDIO |
| modelProtocol |
String |
模型协议:OPENAI_COMPATIBLE / ANTHROPIC_COMPATIBLE / QIANFAN / CUSTOM_HTTP / CUSTOM_WEBSOCKET / DOUBAO / BAILIAN / ORIGINAL |
| path |
String |
路径 |
| methods |
List<String> |
请求方法列表 |
| headerList |
List<AiGwApiHeaderUO> |
逻辑路由入口的公共请求头匹配条件 |
| queryList |
List<AiGwApiQueryUO> |
逻辑路由入口的公共查询参数匹配条件 |
| matchRules |
List<MatchRuleUO> |
逻辑路由下的匹配规则,按生效顺序返回 |
| fallbackEnabled |
Boolean |
Model 路由 Fallback 开关 |
| fallbackBackendList |
List<AiGwApiBackendBindUO> |
Fallback 后端列表,按 fallbackOrder 排序 |
| securityProtection |
AiGwApiSecurityProtectionUO |
API 安全防护配置 |
| plugins |
List<AiGwApiPluginUO> |
当前 API 适用的插件列表,按插件顺序排列,包含禁用状态 |
| priorityNumber |
long |
优先级(0-9999),0 为最高优先级 |
| consumerAuthEnabled |
Boolean |
是否开启消费者认证(仅反映 API 自身,不含服务级继承) |
| updateTime |
String |
修改时间 |
AiGwApiListReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| keyword |
String |
否 |
关键字 |
| keywordType |
String |
否 |
关键字类型 |
| pageNo |
int |
否 |
页码 |
| pageSize |
int |
否 |
每页数据项数目 |
| order |
String |
否 |
排序方向 |
| orderBy |
String |
否 |
排序字段 |
| orders |
List<OrderModel> |
否 |
多重排序 |
| filters |
List<FilterModel> |
否 |
过滤字段 |
| instanceId |
String |
是 |
网关实例 ID |
| searchContent |
String |
否 |
查询内容 |
| backendId |
String |
否 |
后端 ID |
| serviceId |
String |
否 |
服务 ID |
| routeType |
String |
否 |
路由类型:HTTP_ROUTE / MODEL_ROUTE / AGENT_ROUTE |
| apiType |
String |
否 |
API 类型筛选条件:HTTP/WebSocket API 传 HTTP_ROUTE / WEB_SOCKET,Agent 路由传 http / websocket |
| publishStatus |
String |
否 |
发布状态:PUBLISHED / OFFLINE |
DescribeModelRoutePathOptionsResp
ModelRoutePathOptionUO
| 参数名称 |
类型 |
描述 |
| method |
String |
请求方法 |
| path |
String |
对外访问路径(含服务 BasePath) |
| upstreamPath |
String |
转发至上游后端的路径 |
| basePathStrip |
Boolean |
是否在转发时移除 BasePath |
说明:Model 路由路径选项列表
DescribeModelRoutePathOptionsReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| serviceId |
String |
是 |
Model 服务 ID |
PreviewUpdateAiGwApiResp
UpdateAiGwApiPublishStatusResp
无特殊参数。
UpdateAiGwApiPublishStatusReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| id |
List<String> |
是 |
API ID 列表 |
AiGwApiResp
| 参数名称 |
类型 |
描述 |
| apiId |
String |
API ID |
UpdateAiGwApiReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| apiId |
String |
是 |
API ID |
| name |
String |
是 |
API 名称 |
| description |
String |
否 |
路由描述 |
| methods |
List<String> |
否 |
请求方法 |
| path |
String |
否 |
路径 |
| urlRewrite |
Boolean |
否 |
路径重写 |
| urlRewritePath |
String |
否 |
路径重写:重写后的路径 |
| urlRewriteHost |
String |
否 |
路径重写:重写后的 Host |
| urlRewriteType |
String |
否 |
路径重写匹配类型:Exact / Prefix / Regex;开启路径重写时必填 |
| urlRewriteRegexMatch |
String |
否 |
正则重写模式,如 ^/user/(+)(/.*)$;重写类型为 Regex 时必填 |
| urlRewriteRegexRewrite |
String |
否 |
正则重写替换表达式,如 /instance/\1;重写类型为 Regex 时必填 |
| matchType |
String |
否 |
匹配类型 |
| apiType |
String |
否 |
API 类型,仅用于一致性校验;不传时保留原值 |
| modelBackendStrategy |
String |
否 |
后端策略:HTTP/WebSocket API 显式传 SINGLE / WEIGHT 时使用 weight 新协议;不传时按旧版 matchContent 百分比协议校验,并保留或推导落库策略;Model 路由支持 SINGLE / MODEL_NAME / WEIGHT;Agent 路由不传 |
| headerList |
List<AiGwApiHeader> |
否 |
请求头 |
| queryList |
List<AiGwApiQuery> |
否 |
请求参数 |
| backendList |
List<AiGwApiBackendBind> |
否 |
后端配置 |
| deletedRuleIds |
List<String> |
否 |
本次编辑删除的 MODEL_NAME 规则 ID |
| retries |
Boolean |
否 |
重试 |
| attempts |
int |
否 |
重试次数 |
| perTryTimeout |
int |
否 |
单次重试超时时间(毫秒) |
| retryOn |
List<String> |
否 |
重试条件 |
| httpCodes |
List<int> |
否 |
触发重试的响应状态码 |
| timeout |
Boolean |
否 |
超时时间 |
| timeoutTime |
int |
否 |
超时时间(毫秒) |
| priorityNumber |
long |
否 |
优先级(0-9999),0 为最高优先级,默认 9999 |
| fallbackEnabled |
Boolean |
否 |
Model 路由 Fallback 开关 |
| fallbackFirstTokenTimeoutMs |
int |
否 |
Model 路由 Fallback 首次响应超时时间(毫秒),0 表示不启用 |
| fallbackTriggerScope |
String |
否 |
Model 路由 Fallback 触发范围,仅支持 BACKEND_ERROR_ONLY |
| consumerAuthEnabled |
Boolean |
否 |
是否开启消费者认证 |
| authorizationType |
String |
否 |
消费者认证方式:API_KEY / AK_SK;开启认证时必填 |
| consumerIds |
List<String> |
否 |
绑定消费者 ID 列表,可为空(开启但空 = 全部拒绝) |
| consumerAuthorizations |
List<ConsumerAuthorization> |
否 |
消费者认证项列表;同一消费者可同时以 API_KEY 和 AK_SK 授权 |
CreateAiGwPluginCustomResp
| 参数名称 |
类型 |
描述 |
| pluginReleaseId |
String |
插件 Release ID |
CreateAiGwPluginCustomReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| name |
String |
是 |
插件名称 |
| instanceId |
String |
是 |
网关实例 ID |
| config |
String |
是 |
插件配置 |
| pluginPhase |
String |
否 |
插件阶段 |
| executionPriority |
int |
否 |
执行优先级 |
| description |
String |
否 |
插件描述 |
| version |
String |
否 |
插件版本 |
| versionDescription |
String |
否 |
版本描述 |
DeletePluginReleaseBindingReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| pluginBindingId |
String |
是 |
插件绑定 ID |
| 参数名称 |
类型 |
描述 |
| orderBy |
String |
排序字段 |
| order |
String |
排序方向 |
| pageNo |
int |
页码 |
| pageSize |
int |
每页数据项数目 |
| totalCount |
long |
数据总条数 |
| result |
List<InstallableApisUO> |
可安装的路由列表 |
InstallableApisUO
| 参数名称 |
类型 |
描述 |
| apiId |
String |
路由 ID |
| apiName |
String |
路由名称 |
| isBinding |
Boolean |
是否绑定当前插件 |
| 参数名称 |
类型 |
是否必需 |
描述 |
| keyword |
String |
否 |
关键字 |
| keywordType |
String |
否 |
关键字类型 |
| pageNo |
int |
否 |
页码 |
| pageSize |
int |
否 |
每页数据项数目 |
| order |
String |
否 |
排序方向 |
| orderBy |
String |
否 |
排序字段 |
| orders |
List<OrderModel> |
否 |
多重排序 |
| filters |
List<FilterModel> |
否 |
过滤字段 |
| pluginId |
String |
是 |
插件 Release ID |
| serviceId |
String |
是 |
服务 ID |
| apiName |
String |
否 |
路由名称 |
InstallableInstancesUO
| 参数名称 |
类型 |
描述 |
| instanceId |
String |
实例 ID |
| instanceName |
String |
实例名称 |
| status |
String |
状态 |
| isBinding |
Boolean |
是否绑定当前插件 |
DescribeInstallableInstancesReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| pluginId |
String |
是 |
插件 Release ID |
| instanceIdOrName |
String |
否 |
实例 ID 或名称 |
| 参数名称 |
类型 |
描述 |
| orderBy |
String |
排序字段 |
| order |
String |
排序方向 |
| pageNo |
int |
页码 |
| pageSize |
int |
每页数据项数目 |
| totalCount |
long |
数据总条数 |
| result |
List<DescribeInstalledApisUO> |
已安装插件路由列表 |
DescribeInstalledApisUO
| 参数名称 |
类型 |
描述 |
| apiId |
String |
路由 ID |
| pluginBindingId |
String |
插件绑定 ID |
| apiName |
String |
路由名称 |
| serviceName |
String |
服务名称 |
| pluginConfig |
String |
插件配置 |
| status |
String |
状态:Enable / Disable |
| routeType |
String |
路由类型:HTTP_ROUTE / MODEL_ROUTE / AGENT_ROUTE |
| effectiveScope |
String |
插件绑定的生效范围 |
| 参数名称 |
类型 |
是否必需 |
描述 |
| keyword |
String |
否 |
关键字 |
| keywordType |
String |
否 |
关键字类型 |
| pageNo |
int |
否 |
页码 |
| pageSize |
int |
否 |
每页数据项数目 |
| order |
String |
否 |
排序方向 |
| orderBy |
String |
否 |
排序字段 |
| orders |
List<OrderModel> |
否 |
多重排序 |
| filters |
List<FilterModel> |
否 |
过滤字段 |
| pluginBindingId |
String |
是 |
插件绑定 ID |
| routeTypes |
List<String> |
否 |
路由类型列表,支持 HTTP_ROUTE / MODEL_ROUTE / AGENT_ROUTE 多选 |
PageResultRespDescribeInstalledDomainsUO
| 参数名称 |
类型 |
描述 |
| orderBy |
String |
排序字段 |
| order |
String |
排序方向 |
| pageNo |
int |
页码 |
| pageSize |
int |
每页数据项数目 |
| totalCount |
long |
数据总条数 |
| result |
List<DescribeInstalledDomainsUO> |
已安装插件域名列表 |
DescribeInstalledDomainsUO
| 参数名称 |
类型 |
描述 |
| pluginBindingId |
String |
插件绑定 ID |
| effectiveLevel |
String |
生效级别 |
| serviceDomainId |
String |
服务域名 ID |
| domainName |
String |
域名 |
| protocolType |
String |
访问协议 |
| serviceId |
String |
服务 ID |
| serviceName |
String |
服务名称 |
| instanceId |
String |
网关实例 ID |
| pluginConfig |
String |
插件配置 |
| status |
String |
状态 |
DescribeInstalledDomainsByPageReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| keyword |
String |
否 |
关键字 |
| keywordType |
String |
否 |
关键字类型 |
| pageNo |
int |
否 |
页码 |
| pageSize |
int |
否 |
每页数据项数目 |
| order |
String |
否 |
排序方向 |
| orderBy |
String |
否 |
排序字段 |
| orders |
List<OrderModel> |
否 |
多重排序 |
| filters |
List<FilterModel> |
否 |
过滤字段 |
| pluginBindingId |
String |
是 |
插件绑定 ID |
| 参数名称 |
类型 |
描述 |
| orderBy |
String |
排序字段 |
| order |
String |
排序方向 |
| pageNo |
int |
页码,从 1 开始 |
| pageSize |
int |
每页返回的记录数 |
| totalCount |
long |
符合条件的记录总数 |
| result |
List<DescribeInstalledInstancesUO> |
当前页的结果列表 |
DescribeInstalledInstancesUO
| 参数名称 |
类型 |
描述 |
| instanceId |
String |
实例 ID |
| instanceName |
String |
实例名称 |
| pluginId |
String |
插件 ID |
| pluginImage |
String |
插件标识 |
| pluginBindingId |
String |
插件绑定 ID |
| version |
String |
插件版本 |
| description |
String |
插件描述 |
| 参数名称 |
类型 |
是否必需 |
描述 |
| keyword |
String |
否 |
关键字 |
| keywordType |
String |
否 |
关键字类型 |
| pageNo |
int |
否 |
页码 |
| pageSize |
int |
否 |
每页数据项数目 |
| order |
String |
否 |
排序方向 |
| orderBy |
String |
否 |
排序字段 |
| orders |
List<OrderModel> |
否 |
多重排序 |
| filters |
List<FilterModel> |
否 |
过滤字段 |
| pluginId |
String |
是 |
插件 Release ID |
| instanceId |
String |
否 |
实例 ID |
DescribeKuAppTokenUO
| 参数名称 |
类型 |
描述 |
| token |
String |
令牌 |
DescribePluginReleaseBindingReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| pluginBindingId |
String |
是 |
插件绑定 ID |
DescribePluginSupportedLevelsUO
| 参数名称 |
类型 |
描述 |
| pluginId |
String |
插件 Release ID |
| supportedLevels |
List<String> |
插件支持的生效级别:Instance / Domain / Api |
DescribePluginSupportedLevelsReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| pluginId |
String |
是 |
插件 Release ID |
AiGwPluginReleaseDetailUO
| 参数名称 |
类型 |
描述 |
| pluginId |
String |
插件 ID |
| name |
String |
插件名称 |
| description |
String |
插件描述 |
| type |
String |
插件类型:FlowControl-流量管控,Auth-认证鉴权 |
| version |
String |
插件版本 |
| document |
String |
说明文档 |
| defaultConfig |
String |
默认配置 |
| executionPriority |
int |
执行优先级 |
| pluginPhase |
String |
插件阶段 |
| versionDescription |
String |
版本描述 |
| pluginType |
String |
插件实现类型:system_wasm / system_extproc / system_envoyfilter_wasm / custom_wasm / custom_extproc |
| pluginSource |
String |
插件来源:GATEWAY / CUSTOM |
| effectiveExecutionPriority |
int |
偏移后的真实执行优先级 |
AiGwDescribePluginReleaseReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| pluginId |
String |
是 |
插件 ID |
DescribePluginReleaseBindingUO
| 参数名称 |
类型 |
描述 |
| pluginBindingId |
String |
插件绑定 ID |
| pluginId |
String |
插件 ID |
| pluginName |
String |
插件名称 |
| pluginImage |
String |
插件镜像 |
| version |
String |
插件版本 |
| pluginConfig |
String |
插件配置 |
| pluginType |
String |
插件类型 |
| effectiveLevel |
String |
生效级别 |
| instanceId |
String |
网关实例 ID |
| instanceName |
String |
网关实例名称 |
| serviceId |
String |
服务 ID |
| serviceName |
String |
服务名称 |
| apiId |
String |
路由 ID |
| apiName |
String |
路由名称 |
| status |
String |
状态 |
| description |
String |
描述 |
| executionPriority |
int |
执行优先级 |
| pluginPhase |
String |
插件阶段 |
| versionDescription |
String |
版本描述 |
| pluginCategory |
String |
用户可见插件能力分类 |
| pluginSource |
String |
插件来源:GATEWAY / CUSTOM |
| effectiveExecutionPriority |
int |
偏移后的真实执行优先级 |
| effectiveScope |
String |
路由类型生效范围 |
DescribePluginReleaseBindingsByInstanceIdReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| instanceId |
String |
是 |
网关实例 ID |
ListAiGwPluginReleaseUO
| 参数名称 |
类型 |
描述 |
| pluginId |
String |
插件 ID |
| pluginImage |
String |
插件标识 |
| name |
String |
插件名称 |
| description |
String |
插件描述 |
| type |
String |
插件类型:FlowControl-流量管控,Auth-认证鉴权 |
| version |
String |
插件版本 |
| pluginSource |
String |
插件来源:GATEWAY / CUSTOM |
| executionPriority |
int |
数据库保存的用户优先级 |
| effectiveExecutionPriority |
int |
偏移后的真实执行优先级 |
DescribePluginsReq
| 参数名称 |
类型 |
描述 |
| name |
String |
插件名称 |
InstallPluginReleaseToApiReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| pluginId |
String |
是 |
插件 Release ID |
| apiIds |
List<String> |
是 |
路由 ID 列表 |
| pluginConfig |
String |
否 |
插件配置 |
| status |
String |
是 |
启用状态:Enable / Disable |
InstallPluginReleaseToDomainReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| pluginId |
String |
是 |
插件 Release ID |
| serviceDomainIds |
List<String> |
是 |
服务域名 ID 列表 |
| pluginConfig |
String |
否 |
插件配置 |
| status |
String |
是 |
启用状态 |
CreateAiGwPluginReleaseBindingResp
| 参数名称 |
类型 |
描述 |
| pluginBindingIds |
List<String> |
插件绑定 ID 列表 |
InstallPluginReleaseToInstanceReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| pluginId |
String |
是 |
插件 Release ID |
| instanceIds |
List<String> |
是 |
实例 ID 列表 |
| pluginConfig |
String |
否 |
插件配置 |
| status |
String |
否 |
启用状态:Enable / Disable |
UpdateAiGwPluginCustomReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| pluginReleaseId |
String |
是 |
插件 Release ID |
| name |
String |
否 |
插件名称 |
| config |
String |
否 |
插件配置 |
| pluginPhase |
String |
否 |
插件阶段 |
| executionPriority |
int |
否 |
执行优先级 |
| description |
String |
否 |
插件描述 |
| version |
String |
否 |
插件版本 |
| versionDescription |
String |
否 |
版本描述 |
UpdatePluginReleaseBindingStatusReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| pluginBindingId |
String |
是 |
插件绑定 ID |
| status |
String |
是 |
启用状态:Enable / Disable |
UpdateAiGwPluginResp
无特殊参数。
UpdatePluginReleaseBindingReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| pluginBindingId |
String |
是 |
插件绑定 ID |
| pluginConfig |
String |
否 |
插件配置 |
| status |
String |
是 |
启用状态:Enable / Disable |
CloseBlsResp
无特殊参数。
CloseBlsReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| instanceId |
String |
是 |
网关实例 ID |
CloseMetricResp
无特殊参数。
CloseMetricReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| instanceId |
String |
是 |
网关实例 ID |
CloseOtelResp
无特殊参数。
CloseOtelReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| instanceId |
String |
是 |
网关实例 ID |
CreateAiGwInstanceResp
| 参数名称 |
类型 |
描述 |
| orderId |
String |
订单 ID |
| instanceIds |
List<String> |
实例 ID 列表 |
DeleteAiGwInstanceResp
无特殊参数。
DeleteAiGwInstanceReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| instanceIds |
List<String> |
是 |
实例 ID 列表 |
PriceInfoResp
| 参数名称 |
类型 |
描述 |
| spec |
String |
套餐 |
| price |
Double |
折后单价 |
| catalogPrice |
Double |
目录单价 |
| discountRate |
Double |
用户当前折扣率 |
| eipPriceInfo |
EipPriceInfo |
EIP 询价明细,未询价时为空 |
| snicPriceInfo |
SnicPriceInfo |
服务网卡询价明细,未询价时为空 |
SnicPriceInfo
| 参数名称 |
类型 |
描述 |
| configMoney |
String |
配置价格 |
| configUnit |
String |
配置计费单位 |
| catalogConfigMoney |
String |
配置目录价 |
| configDiscountRate |
String |
配置折扣率 |
| configSkuId |
String |
配置 SKU ID |
| networkMoney |
String |
网络价格 |
| networkUnit |
String |
网络计费单位 |
| catalogNetworkMoney |
String |
网络目录价 |
| networkDiscountRate |
String |
网络折扣率 |
| networkSkuId |
String |
网络 SKU ID |
| perMoney |
String |
按量单价 |
| currency |
String |
币种 |
说明:服务网卡询价明细,未询价时为空
EipPriceInfo
| 参数名称 |
类型 |
描述 |
| configMoney |
String |
配置价格 |
| configUnit |
String |
配置计费单位 |
| catalogConfigMoney |
String |
配置目录价 |
| configDiscountRate |
String |
配置折扣率 |
| configSkuId |
String |
配置 SKU ID |
| networkMoney |
String |
网络价格 |
| networkUnit |
String |
网络计费单位 |
| catalogNetworkMoney |
String |
网络目录价 |
| networkDiscountRate |
String |
网络折扣率 |
| networkSkuId |
String |
网络 SKU ID |
| idleMoney |
String |
闲置价格 |
| idleUnit |
String |
闲置计费单位 |
| catalogIdleMoney |
String |
闲置目录价 |
| idleDiscountRate |
String |
闲置折扣率 |
| idleSkuId |
String |
闲置 SKU ID |
| perMoney |
String |
按量单价 |
| currency |
String |
币种 |
说明:EIP 询价明细,未询价时为空
PriceReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| spec |
String |
是 |
套餐 |
| blbSpec |
String |
是 |
BLB 规格类型 |
| podCnt |
int |
是 |
网关 Pod 数量 |
| purchaseNum |
int |
否 |
购买数量 |
| billingModel |
BillingModel |
否 |
计费信息 |
| eipConfig |
EipConfigReq |
否 |
新购 EIP 询价配置 |
| snicConfig |
SnicConfigReq |
否 |
服务网卡询价配置 |
SnicConfigReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| bandwidth |
int |
是 |
服务网卡带宽,单位 Mbps |
说明:服务网卡配置
EipConfigReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| name |
String |
否 |
EIP 名称,可空 |
| bandwidthInMbps |
int |
是 |
公网带宽,单位 Mbps |
| routeType |
String |
否 |
线路类型 BGP / BGP_S,默认 BGP |
| billingMethod |
String |
是 |
计费方式 ByTraffic / ByBandwidth |
说明:新购 EIP 询价配置,非空表示同时询 EIP 价格
BillingModel
| 参数名称 |
类型 |
描述 |
| chargeType |
String |
付费方式,当前仅支持 Postpaid(后付费) |
| period |
int |
预付费时长 |
| periodUnit |
String |
预付费时长单位 |
| autoRenew |
Boolean |
是否自动续费 |
| autoRenewPeriodUnit |
String |
自动续费时长单位(月或年) |
| autoRenewPeriod |
int |
自动续费时长 |
| spotPriceLimit |
String |
竞价实例出价金额;自定义出价低于市场价时不允许创建 |
| spotStrategy |
String |
竞价实例出价模型 |
说明:计费信息
AiGwInstanceFlavorInfo
| 参数名称 |
类型 |
描述 |
| spec |
String |
套餐 |
| zoneList |
List<String> |
可用区列表 |
AiGwInstanceFlavorGetReq
| 参数名称 |
类型 |
描述 |
| spec |
String |
套餐 |
AiGwInstanceUO
| 参数名称 |
类型 |
描述 |
| instanceName |
String |
实例名称 |
| instanceId |
String |
实例 ID |
| status |
String |
状态 |
| expireTime |
String |
过期时间 |
| createTime |
String |
创建时间 |
| spec |
String |
实例规格 |
| podCnt |
int |
网关 Pod 数量 |
| blbSpec |
String |
BLB 规格类型 |
| chargeType |
String |
付费类型 |
| publicEnabled |
Boolean |
是否开启公网访问 |
| privateEnabled |
Boolean |
是否开启私网访问 |
| vpcId |
String |
所在 VPC ID |
| vpcName |
String |
所在 VPC 名称 |
| subnetIds |
List<String> |
所在子网 ID 列表 |
| subnetName |
List<String> |
所在子网名称 |
| securityGroupName |
String |
安全组名称 |
| securityGroupId |
String |
安全组 ID |
| publicIp |
String |
公网 IP |
| eipId |
String |
绑定的 EIP ID |
| publicPort |
String |
公网端口 |
| internalIp |
String |
内网 IP |
| intranetPort |
String |
内网端口 |
| cpromId |
String |
CProm 监控 ID |
| blsConfig |
BlsModel |
BLS 日志收集配置 |
| otelConfig |
OtelModel |
OTel 链路追踪配置 |
OtelModel
| 参数名称 |
类型 |
是否必需 |
描述 |
| enableOtel |
Boolean |
是 |
是否开启 OTel 链路追踪功能 |
| otelCollectorReplicas |
int |
否 |
OTel Collector 副本数 |
| otelCollectorReqCpu |
String |
否 |
OTel Collector 请求的 CPU 资源(Kubernetes Quantity 格式) |
| otelCollectorReqMem |
String |
否 |
OTel Collector 请求的内存资源(Kubernetes Quantity 格式) |
| otelCollectorMaxCpu |
String |
否 |
OTel Collector 最大 CPU 限制(Kubernetes Quantity 格式) |
| otelCollectorMaxMem |
String |
否 |
OTel Collector 最大内存限制(Kubernetes Quantity 格式) |
| otelSamplingPercentage |
int |
否 |
采样百分比 (0-100) |
说明:OTel 链路追踪配置
BlsModel
| 参数名称 |
类型 |
是否必需 |
描述 |
| enableBls |
Boolean |
是 |
是否开启 BLS 收集日志功能 |
| enablePluginLog |
Boolean |
否 |
是否开启插件日志采集(不开启则仅采集访问日志) |
| rotateSize |
String |
否 |
触发日志轮转的文件大小(logrotate size 格式) |
| rotateCount |
int |
否 |
日志轮转的最大文件个数 |
| rotateIntervalSeconds |
String |
否 |
日志轮转任务触发的间隔时间 |
| reqCpu |
String |
否 |
请求的 CPU 资源(Kubernetes Quantity 格式) |
| reqMem |
String |
否 |
请求的内存资源(Kubernetes Quantity 格式) |
| maxCpu |
String |
否 |
最大 CPU 限制(Kubernetes Quantity 格式) |
| maxMem |
String |
否 |
最大内存限制(Kubernetes Quantity 格式) |
| maxVolume |
String |
否 |
BLS Agent Sidecar 的最大卷大小(Kubernetes Quantity 格式) |
| logbeatBlsServerEndpoint |
String |
否 |
BLS Server 上报地址,非必填 |
| accessProjectName |
String |
否 |
访问日志所属的日志组名称,不指定则使用默认日志组(default) |
| accessLogStoreName |
String |
否 |
访问日志所属的日志集名称,不指定则创建默认日志集 |
| pluginProjectName |
String |
否 |
插件日志所属的日志组名称,不指定则使用默认日志组(default) |
| pluginLogStoreName |
String |
否 |
插件日志所属的日志集名称,不指定则创建默认日志集 |
说明:BLS 日志收集配置
AiGwInstanceGetReq
| 参数名称 |
类型 |
描述 |
| instanceId |
String |
网关实例 ID |
| 参数名称 |
类型 |
描述 |
| orderBy |
String |
排序字段 |
| order |
String |
排序方向 |
| pageNo |
int |
页码,从 1 开始 |
| pageSize |
int |
每页返回的记录数 |
| totalCount |
long |
符合条件的记录总数 |
| result |
List<ListAiGwInstanceUO> |
当前页的结果列表 |
ListAiGwInstanceUO
| 参数名称 |
类型 |
描述 |
| instanceId |
String |
实例 ID |
| instanceName |
String |
实例名称 |
| status |
String |
状态 |
| podCnt |
int |
网关 Pod 数量 |
| blbSpec |
String |
BLB 规格类型 |
| createTime |
String |
创建时间 |
| publicIp |
String |
公网 IP(绑定的 EIP 地址) |
| eipId |
String |
绑定的 EIP ID(未绑定时为空) |
| internalIp |
String |
内网 IP |
| serviceCount |
int |
服务数量 |
| cpromId |
String |
CProm 监控 ID |
| 参数名称 |
类型 |
描述 |
| keyword |
String |
关键字 |
| keywordType |
String |
关键字类型 |
| pageNo |
int |
页码 |
| pageSize |
int |
每页数据项数目 |
| order |
String |
排序方向 |
| orderBy |
String |
排序字段 |
| orders |
List<OrderModel> |
多重排序 |
| filters |
List<FilterModel> |
过滤字段 |
| searchContent |
String |
搜索内容 |
| status |
String |
状态:Creating(创建中)、Active(运行中)、Expired(已到期)、Error(异常) |
| vpcId |
String |
VPC ID,按实例所属 VPC 精确筛选,不传则不按 VPC 过滤 |
QueryMetricReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| instanceId |
String |
是 |
网关实例 ID |
| query |
String |
是 |
查询条件 |
QueryMetricResp
| 参数名称 |
类型 |
描述 |
| status |
String |
查询状态 |
| data |
Object |
查询结果 |
| isPartial |
String |
是否为部分结果 |
QueryRangeMetricReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| instanceId |
String |
是 |
网关实例 ID |
| query |
String |
是 |
查询条件 |
| step |
String |
是 |
查询步长 |
| start |
String |
是 |
开始时间 |
| end |
String |
是 |
结束时间 |
InstanceAccessSwitchReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| instanceId |
String |
是 |
网关实例 ID |
OpenInstancePrivateAccessReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| instanceId |
String |
是 |
网关实例 ID |
| snicConfig |
SnicConfigReq |
是 |
服务网卡询价配置 |
OpenInstancePublicAccessReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| instanceId |
String |
是 |
网关实例 ID |
| eip |
String |
是 |
要绑定的已有 EIP 地址 |
OpenBlsResp
无特殊参数。
OpenBlsReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| instanceId |
String |
是 |
网关实例 ID |
| blsConfig |
BlsModel |
是 |
BLS 日志收集配置 |
OpenMetricResp
无特殊参数。
OpenMetricReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| instanceId |
String |
是 |
网关实例 ID |
| cpromId |
String |
是 |
CProm 监控 ID |
OpenOtelResp
无特殊参数。
OpenOtelReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| instanceId |
String |
是 |
网关实例 ID |
| otelConfig |
OtelModel |
是 |
OTel 链路追踪配置 |
InstanceAccessSwitchResp
| 参数名称 |
类型 |
描述 |
| success |
Boolean |
是否成功 |
RebindInstancePublicEipReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| instanceId |
String |
是 |
网关实例 ID |
| eip |
String |
是 |
新的已有 EIP 地址 |
UpdateAiGwInstanceResp
无特殊参数。
UpdateAiGwInstanceReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| instanceId |
String |
是 |
网关实例 ID |
| instanceName |
String |
是 |
实例名称 |
CreateAiGwInstanceReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| spec |
String |
是 |
实例套餐 |
| podCnt |
int |
是 |
网关 Pod 数量 |
| blbSpec |
String |
是 |
BLB 规格类型 |
| instanceName |
String |
是 |
实例名称 |
| description |
String |
否 |
描述 |
| publicEnabled |
Boolean |
是 |
是否开启公网访问 |
| privateEnabled |
Boolean |
是 |
是否开启私网访问 |
| blbId |
String |
否 |
指定的 BLB ID |
| subnetIds |
List<String> |
否 |
子网 ID 列表 |
| purchaseCount |
int |
是 |
购买数量 |
| billingModel |
BillingModel |
否 |
计费信息 |
| cpromId |
String |
否 |
CProm 监控 ID |
| eipConfig |
EipConfigReq |
否 |
新购 EIP 询价配置 |
| eip |
String |
否 |
绑定已有 EIP 的地址;与 eipConfig 二选一 |
| snicConfig |
SnicConfigReq |
否 |
服务网卡询价配置 |
| blsConfig |
BlsModel |
否 |
BLS 日志收集配置 |
BindConsumersReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| serviceId |
String |
否 |
服务 ID;与 apiId 二选一 |
| apiId |
String |
否 |
API ID;与 serviceId 二选一(apiId 非空视为 Api 级) |
| consumerIds |
List<String> |
是 |
待绑定消费者 ID 列表 |
CheckConsumerNameRepeatedUO
| 参数名称 |
类型 |
描述 |
| consumerNameCanUse |
Boolean |
消费者名称是否可用:true 表示可用,false 表示名称已存在 |
CheckConsumerNameRepeatedReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| consumerName |
String |
是 |
消费者名称 |
CreateAiGwConsumerAuthorizationInfoResp
| 参数名称 |
类型 |
描述 |
| authorizationInfoId |
String |
鉴权信息 ID,用于后续查询、重置、删除 |
| apiKey |
String |
API Key 明文,仅认证方式为 API_KEY 时返回;仅创建时返回一次,请及时保存 |
| ak |
String |
Access Key 明文,仅认证方式为 AK_SK 时返回 |
| sk |
String |
Secret Key 明文,仅认证方式为 AK_SK 时返回;仅创建时返回一次,请及时保存 |
CreateAiGwConsumerAuthorizationInfoReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| consumerId |
String |
是 |
消费者 ID |
| authorizationType |
String |
是 |
认证方式:API_KEY / AK_SK |
| createType |
String |
否 |
生成方式,仅认证方式为 API_KEY 时生效:System(系统生成)/ Custom(自定义) |
| apiKey |
String |
否 |
自定义 API Key,仅生成方式为 Custom 时必填 |
CreateAiGwConsumerAuthorizationResp
| 参数名称 |
类型 |
描述 |
| authorizationRuleId |
String |
授权规则 ID |
CreateAiGwConsumerAuthorizationReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| consumerId |
String |
是 |
消费者 ID |
| authorizationType |
String |
否 |
已废弃,无需传入;认证方式由目标服务或路由的认证配置继承 |
| effectiveLevel |
String |
是 |
授权级别:Service(服务级别)/ Api(路由级别) |
| instanceId |
String |
是 |
网关实例 ID |
| serviceId |
String |
是 |
服务 ID |
| apiId |
String |
否 |
路由 ID;effectiveLevel 为 Api 时必填 |
| description |
String |
是 |
备注 |
CreateAiGwConsumerResp
| 参数名称 |
类型 |
描述 |
| consumerId |
String |
消费者 ID |
CreateAiGwConsumerReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| consumerName |
String |
是 |
消费者名称 |
| description |
String |
否 |
消费者描述 |
| status |
String |
是 |
启用状态:Enable(启用)/ Disable(禁用) |
DeleteAiGwConsumerResp
无特殊参数。
DeleteAiGwConsumerApiKeyReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| authorizationInfoIds |
List<String> |
是 |
鉴权信息 ID 列表 |
DeleteAiGwConsumerAuthorizationReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| authorizationRuleIds |
List<String> |
是 |
授权规则 ID 列表 |
DeleteAiGwConsumerReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| consumerIds |
List<String> |
是 |
消费者 ID 列表 |
| 参数名称 |
类型 |
描述 |
| orderBy |
String |
排序字段 |
| order |
String |
排序方向 |
| pageNo |
int |
页码 |
| pageSize |
int |
每页数据项数目 |
| totalCount |
long |
数据总条数 |
| result |
List<DescribeBindableConsumersResp> |
当前页的消费者列表 |
DescribeBindableConsumersResp
| 参数名称 |
类型 |
描述 |
| consumerId |
String |
消费者 ID |
| name |
String |
消费者名称 |
| status |
String |
消费者状态:Enable / Disable |
| bound |
Boolean |
是否已绑定到目标资源 |
| hasCredential |
Boolean |
是否持有目标资源主表 authorizationType 对应类型凭证 |
DescribeBindableConsumersReq
| 参数名称 |
类型 |
描述 |
| keyword |
String |
关键字 |
| keywordType |
String |
关键字类型 |
| pageNo |
int |
页码 |
| pageSize |
int |
每页数据项数目 |
| order |
String |
排序方向 |
| orderBy |
String |
排序字段 |
| orders |
List<OrderModel> |
多重排序 |
| filters |
List<FilterModel> |
过滤字段 |
| serviceId |
String |
服务 ID;与 apiId 二选一 |
| apiId |
String |
API ID;与 serviceId 二选一 |
| 参数名称 |
类型 |
描述 |
| orderBy |
String |
排序字段 |
| order |
String |
排序方向 |
| pageNo |
int |
页码 |
| pageSize |
int |
每页数据项数目 |
| totalCount |
long |
数据总条数 |
| result |
List<DescribeConsumerAuthResp> |
当前页的消费者授权列表 |
DescribeConsumerAuthResp
| 参数名称 |
类型 |
描述 |
| consumerId |
String |
消费者 ID |
| authorizationRuleId |
String |
授权规则 ID,解绑时传给 DeleteConsumerAuthorizationRule |
| name |
String |
消费者名称;消费者已删除时为空 |
| ruleStatus |
String |
授权规则状态:Enable / Disable |
| consumerStatus |
String |
消费者状态:Enable / Disable;消费者已删除时为空 |
| consumerDescription |
String |
消费者备注;消费者已删除时为空 |
| consumerUpdateTime |
String |
消费者更新时间;消费者已删除时为空 |
| ruleUpdateTime |
String |
授权规则更新时间 |
DescribeConsumerAuthReq
| 参数名称 |
类型 |
描述 |
| keyword |
String |
关键字 |
| keywordType |
String |
关键字类型 |
| pageNo |
int |
页码 |
| pageSize |
int |
每页数据项数目 |
| order |
String |
排序方向 |
| orderBy |
String |
排序字段 |
| orders |
List<OrderModel> |
多重排序 |
| filters |
List<FilterModel> |
过滤字段 |
| serviceId |
String |
服务 ID;与 apiId 二选一 |
| apiId |
String |
API ID;与 serviceId 二选一 |
| searchContent |
String |
搜索关键字,按消费者名称、消费者 ID 右模糊匹配,为空则不过滤 |
DescribeConsumerAuthorizationInfosResp
| 参数名称 |
类型 |
描述 |
| consumerId |
String |
消费者 ID |
| name |
String |
消费者名称 |
| authorizationType |
String |
授权类型:API_KEY / AK_SK |
DescribeConsumerAuthorizationInfosReq
| 参数名称 |
类型 |
描述 |
| keyword |
String |
关键字 |
| keywordType |
String |
关键字类型 |
| pageNo |
int |
页码 |
| pageSize |
int |
每页数据项数目 |
| order |
String |
排序方向 |
| orderBy |
String |
排序字段 |
| orders |
List<OrderModel> |
多重排序 |
| filters |
List<FilterModel> |
过滤字段 |
| consumerId |
String |
消费者 ID;为空时返回全部消费者 |
| authorizationType |
String |
认证方式过滤:API_KEY / AK_SK;为空时返回全部类型 |
| 参数名称 |
类型 |
描述 |
| orderBy |
String |
排序字段 |
| order |
String |
排序方向 |
| pageNo |
int |
页码 |
| pageSize |
int |
每页数据项数目 |
| totalCount |
long |
数据总条数 |
| result |
List<ListAiGwAuthorizationRuleUO> |
当前页的授权规则列表 |
ListAiGwAuthorizationRuleUO
| 参数名称 |
类型 |
描述 |
| authorizationRuleId |
String |
授权规则 ID |
| instanceId |
String |
网关实例 ID |
| instanceName |
String |
实例名称 |
| serviceId |
String |
服务 ID |
| serviceName |
String |
服务名称 |
| apiId |
String |
路由 ID |
| apiName |
String |
路由名称 |
| authorizationType |
String |
认证方式:API_KEY / AK_SK |
| status |
String |
启用状态:Enable(启用)/ Disable(禁用) |
| description |
String |
备注 |
| createTime |
String |
创建时间 |
| updateTime |
String |
更新时间 |
AiGwConsumerAuthorizationListReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| keyword |
String |
否 |
关键字 |
| keywordType |
String |
否 |
关键字类型 |
| pageNo |
int |
否 |
页码 |
| pageSize |
int |
否 |
每页数据项数目 |
| order |
String |
否 |
排序方向 |
| orderBy |
String |
否 |
排序字段 |
| orders |
List<OrderModel> |
否 |
多重排序 |
| filters |
List<FilterModel> |
否 |
过滤字段 |
| consumerId |
String |
是 |
消费者 ID |
| searchContent |
String |
否 |
搜索内容 |
| serviceId |
String |
否 |
服务 ID,精确过滤,只返回该服务下的授权规则 |
| effectiveLevel |
String |
否 |
授权级别:Service(服务级别)/ Api(路由级别) |
| instanceSearchContent |
String |
否 |
按实例名称搜索 |
| serviceSearchContent |
String |
否 |
按服务名称搜索 |
| apiSearchContent |
String |
否 |
按路由名称搜索 |
| authorizationType |
String |
否 |
认证方式:API_KEY / AK_SK |
| status |
String |
否 |
启用状态:Enable / Disable |
DescribeConsumerBackendsResp
BackendItem
| 参数名称 |
类型 |
描述 |
| backendId |
String |
后端 ID |
| backendName |
String |
后端名称 |
DescribeConsumerBackendsReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| consumerId |
String |
是 |
消费者 ID |
AiGwConsumerUO
| 参数名称 |
类型 |
描述 |
| consumerId |
String |
消费者 ID |
| consumerName |
String |
消费者名称 |
| status |
String |
启用状态:Disable-禁用,Enable-启用 |
| createTime |
String |
创建时间 |
| description |
String |
消费者描述 |
| apiKeys |
Map<String, String> |
API Key 凭证,key 为鉴权信息 ID,value 为 API Key |
| akSk |
Map<String, Object> |
AK / SK 凭证,key 为鉴权信息 ID,value 为 AK 与 SK 键值对 |
AiGwConsumerGetReq
| 参数名称 |
类型 |
描述 |
| consumerId |
String |
消费者 ID |
| 参数名称 |
类型 |
描述 |
| orderBy |
String |
排序字段 |
| order |
String |
排序方向 |
| pageNo |
int |
页码 |
| pageSize |
int |
每页数据项数目 |
| totalCount |
long |
数据总条数 |
| result |
List<ListAiGwConsumerUO> |
当前页的消费者列表 |
ListAiGwConsumerUO
| 参数名称 |
类型 |
描述 |
| consumerId |
String |
消费者ID |
| consumerName |
String |
消费者名称 |
| status |
String |
启用状态:Disable-禁用,Enable-启用 |
| createTime |
String |
创建时间 |
| updateTime |
String |
更新时间 |
AiGwConsumerListReq
| 参数名称 |
类型 |
描述 |
| keyword |
String |
关键字 |
| keywordType |
String |
关键字类型 |
| pageNo |
int |
页码 |
| pageSize |
int |
每页数据项数目 |
| order |
String |
排序方向 |
| orderBy |
String |
排序字段 |
| orders |
List<OrderModel> |
多重排序 |
| filters |
List<FilterModel> |
过滤字段 |
| searchContent |
String |
搜索内容 |
| status |
String |
消费者状态:Enable / Disable |
ResetAiGwConsumerAuthorizationInfoReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| authorizationInfoId |
String |
是 |
鉴权信息 ID |
| authorizationType |
String |
是 |
认证方式:API_KEY / AK_SK |
| createType |
String |
否 |
生成方式,仅认证方式为 API_KEY 时生效:System(系统生成)/ Custom(自定义) |
| apiKey |
String |
否 |
自定义 API Key,仅生成方式为 Custom 时必填 |
UnbindConsumersReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| serviceId |
String |
否 |
服务 ID;与 apiId 二选一 |
| apiId |
String |
否 |
API ID;与 serviceId 二选一(apiId 非空视为 Api 级) |
| consumerIds |
List<String> |
是 |
待解绑消费者 ID 列表 |
UpdateConsumerAuthStatusReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| serviceId |
String |
否 |
服务 ID;与 apiId 二选一 |
| apiId |
String |
否 |
API ID;与 serviceId 二选一(apiId 非空视为 Api 级) |
| consumerAuthEnabled |
Boolean |
是 |
是否开启消费者认证 |
| authorizationType |
String |
否 |
认证方式:API_KEY / AK_SK;开启认证时必填 |
UpdateAiGwAuthorizationRuleDescriptionReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| authorizationRuleId |
String |
是 |
授权规则 ID |
| description |
String |
是 |
备注 |
CloseAiGwConsumerQuotaReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| consumerId |
String |
是 |
消费者 ID |
AiGwConsumerQuotaDetailResp
| 参数名称 |
类型 |
描述 |
| quotaEnabled |
Boolean |
是否已开启配额 |
| status |
String |
配额状态:ENABLE / DISABLE |
| resetCycle |
String |
重置周期:NONE / DAILY / WEEKLY / MONTHLY |
| resetDay |
int |
重置日:WEEKLY 为 1-7(周一至周日),MONTHLY 为 1-28 |
| resetTime |
String |
每日重置时间,格式 HH:mm |
| totalTokens |
long |
Token 配额总量,-1 表示不限制 |
| usedTokens |
long |
已使用 Token 数 |
| totalTokensNum |
long |
请求次数配额总量,-1 表示不限制 |
| usedTokensNum |
long |
已使用请求次数 |
DescribeAiGwConsumerQuotaReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| consumerId |
String |
是 |
消费者 ID |
UpdateAiGwConsumerAuthorizationReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| authorizationRuleIds |
List<String> |
是 |
授权规则 ID 列表 |
| type |
String |
否 |
更新类型:Enable / Disable |
OpenAiGwConsumerQuotaReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| consumerId |
String |
是 |
消费者 ID |
| resetCycle |
String |
是 |
重置周期:NONE / DAILY / WEEKLY / MONTHLY |
| resetDay |
int |
否 |
重置日:WEEKLY 为 1-7(周一至周日),MONTHLY 为 1-28 |
| resetTime |
String |
否 |
每日重置时间,格式 HH:mm |
| totalTokens |
long |
是 |
Token 配额总量,-1 表示不限制 |
| totalTokensNum |
long |
是 |
请求次数配额总量,-1 表示不限制 |
UpdateAiGwConsumerDescriptionReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| consumerId |
String |
是 |
消费者 ID |
| description |
String |
是 |
备注 |
UpdateAiGwConsumerQuotaReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| consumerId |
String |
是 |
消费者 ID |
| resetCycle |
String |
是 |
重置周期:NONE / DAILY / WEEKLY / MONTHLY |
| resetDay |
int |
否 |
重置日:WEEKLY 为 1-7(周一至周日),MONTHLY 为 1-28 |
| resetTime |
String |
否 |
每日重置时间,格式 HH:mm |
| totalTokens |
long |
是 |
Token 配额总量,-1 表示不限制 |
| totalTokensNum |
long |
是 |
请求次数配额总量,-1 表示不限制 |
| clearUsage |
Boolean |
否 |
是否清空已使用量,仅在变更重置周期时生效 |
ConsumerUsageSummaryResp
| 参数名称 |
类型 |
描述 |
| orderBy |
String |
排序字段 |
| order |
String |
排序方向 |
| pageNo |
int |
页码 |
| pageSize |
int |
每页数据项数目 |
| totalCount |
long |
数据总条数 |
| result |
List<ConsumerUsageSummaryItemResp> |
当前页的用量明细列表 |
| totalInputTokens |
long |
时间段内输入Token总量(不受分页影响) |
| totalOutputTokens |
long |
时间段内输出Token总量(不受分页影响) |
| totalCacheTokens |
long |
时间段内缓存命中Token总量(不受分页影响) |
| totalRequestCount |
long |
时间段内请求次数总计(不受分页影响) |
| totalInputCash |
Double |
时间段内输入金额总计(不受分页影响) |
| totalOutputCash |
Double |
时间段内输出金额总计(不受分页影响) |
| totalCacheCash |
Double |
时间段内缓存金额总计(不受分页影响) |
| totalCash |
Double |
时间段内总金额(不受分页影响) |
ConsumerUsageSummaryItemResp
| 参数名称 |
类型 |
描述 |
| date |
String |
日期,格式 yyyy-MM-dd |
| backendId |
String |
后端 ID |
| backendName |
String |
后端名称 |
| backendDeleted |
Boolean |
该后端是否已删除 |
| totalInputTokens |
long |
输入 Token 总量 |
| totalOutputTokens |
long |
输出 Token 总量 |
| totalCacheTokens |
long |
缓存命中 Token 总量 |
| totalRequestCount |
long |
请求次数 |
| totalInputCash |
Double |
输入金额 |
| totalOutputCash |
Double |
输出金额 |
| totalCacheCash |
Double |
缓存金额 |
| totalCash |
Double |
总金额 |
DescribeConsumerUsageSummaryReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| keyword |
String |
否 |
关键字 |
| keywordType |
String |
否 |
关键字类型 |
| pageNo |
int |
否 |
页码 |
| pageSize |
int |
否 |
每页数据项数目 |
| order |
String |
否 |
排序方向 |
| orderBy |
String |
否 |
排序字段 |
| orders |
List<OrderModel> |
否 |
多重排序 |
| filters |
List<FilterModel> |
否 |
过滤字段 |
| consumerId |
String |
是 |
消费者 ID |
| startTime |
String |
是 |
查询起始时间 |
| endTime |
String |
是 |
查询结束时间 |
| backendId |
String |
否 |
后端 ID,可选,不传查询全部 |
UpdateAiGwConsumerResp
无特殊参数。
UpdateAiGwConsumerStatusReq
| 参数名称 |
类型 |
是否必需 |
描述 |
| consumerId |
String |
是 |
消费者 ID |
| status |
String |
是 |
启用状态:Enable(启用)/ Disable(禁用) |
DeleteAiGwBackendResp
无特殊参数。
UpdateAiGwBackendResp
无特殊参数。
类型编码定义