;
/**
* 归属服务 ID
*/
ServiceId?: string;
/**
* 归属服务名称
*/
ServiceName?: string;
/**
* 灰度规则类别
Standard|Lane
*/
RuleType?: string;
/**
* 全链路灰度策略多个条件之间的匹配方式,与AND,或OR
*/
MatchType?: string;
/**
* 泳道组ID
*/
GroupId?: string;
/**
* 泳道组名称
*/
GroupName?: string;
/**
* 泳道ID
*/
LaneId?: string;
/**
* 泳道名称
*/
LaneName?: string;
/**
* 泳道匹配规则:严格STRICT|宽松PERMISSIVE
*/
MatchMode?: string;
/**
* 泳道标签
*/
LaneTag?: string;
}
/**
* AI 网关Token长度路由规则
*/
export interface AIGWTokenLengthRouteRule {
/**
* token 长度下界,闭区间;0 合法
*/
MinTokenLength: number;
/**
* token 长度上界,闭区间
*/
MaxTokenLength: number;
/**
* 命中该分段后执行的二级路由
*/
Target: AIGWLLMModelServiceSubRoute;
}
/**
* LLM 模型服务
*/
export interface CloudNativeAPIGatewayLLMModelService {
/**
* 模型服务 ID。
*/
Id?: string;
/**
* 模型服务名称。
*/
Name?: string;
/**
* 创建时间。
*/
CreateTime?: string;
/**
* 修改时间。
*/
ModifyTime?: string;
/**
* 服务类型,目前只支持xa0LLMService。
*/
ServiceType?: string;
/**
* 选择模型提供商, 选项:OpenAI、Anthropic、Azure OpenAI、自定义HTTP。
*/
ModelProvider?: string;
/**
* API协议标准,根据供应商动态变化:OpenAI→OpenAI/v1,Anthropic→Anthropic/v1等
*/
ModelProtocol?: string;
/**
* 自定义的模型请求 URL。
*/
UpstreamURL?: string;
/**
* 模型选择方式,选项:Specify(指定模型)、PassThrough(透传请求模型)。
*/
ModelSelector?: string;
/**
* 默认模型,模型选择方式为 Specify 时必填。
*/
DefaultModel?: string;
/**
* 开启模型降级,模型选择方式为 Specify 时必填。
*/
EnableModelFallback?: boolean;
/**
* 可以配置备用模型规则,EnableSpecifyModelFallbackxa0为 true 时必填。
*/
ModelFallbackRule?: CloudNativeAPIGatewayLLMModelFallbackRule;
/**
* 开启模型参数校验,是否校验客户端传递的 model 参数,xa0模型选择方式为 PassThrough 时必填。
*/
EnableModelParamCheck?: boolean;
/**
* 模型检验信息,EnableModelParamCheckxa0为 true 时必填。
*/
ModelParamCheckRule?: CloudNativeAPIGatewayLLMModelParamCheckInfo;
/**
* 描述。
*/
Description?: string;
/**
* 连接超时时间
取值范围:[1, 3600000]
单位:毫秒
默认值:10000
*/
ConnectTimeout?: number;
/**
* 写入超时时间
取值范围:[1, 3600000]
单位:毫秒
默认值:60000
*/
WriteTimeout?: number;
/**
* 读取超时时间
取值范围:[1, 3600000]
单位:毫秒
*/
ReadTimeout?: number;
/**
* 重试次数
取值范围:[0, 5]
单位:次
默认值:0
*/
Retries?: number;
/**
* 路径拼接模式
枚举值:
- FixedPath: 固定路径
- AutoConcat: 自动拼接
*/
UpstreamUrlMode?: string;
/**
* sni
*/
SNI?: string;
/**
* 配额限制
*/
QuotaLimit?: AIGWLLMQuotaLimit;
/**
* 标签
*/
Tags?: string;
/**
* 绑定的模型服务秘钥
*/
SecretKeyIds?: Array;
/**
* 模型改写规则
*/
ModelRewriteRules?: Array;
/**
* 服务来源ID
*/
SourceId?: string;
/**
* 命名空间
*/
Namespace?: string;
/**
* 服务名称
*/
ServiceName?: string;
/**
* 协议
*/
Protocol?: string;
/**
* 扩展参数
*/
ExtParams?: Array;
/**
* 自定义供应商名称
*/
CustomProviderName?: string;
/**
* 是否开启密钥轮转
*/
KeyRotationEnabled?: boolean;
/**
* 密钥轮转周期
单位:天数
*/
KeyRotationPeriodDays?: number;
/**
* 外部服务来源ID
*/
ExternalInstanceId?: string;
/**
* 负载均衡配置
*/
LoadBalanceConfig?: AIGWLoadBalanceConfig;
/**
* 模型服务是否发布到广场
枚举值:
- Published: 已发布
- Unpublished: 未发布
*/
PublishStatus?: string;
/**
* 模型服务是否可以发布
*/
CanPublish?: boolean;
/**
* 同步状态
枚举值:
*/
SyncStatus?: string;
/**
* 资源类型
枚举值:
- Public: 公共
- Private: 私有
- SourceDelete: 资源删除
*/
SourceType?: string;
/**
* 同步版本
*/
SyncedVersion?: string;
/**
* 健康状态
枚举值:
*/
Status?: string;
/**
* 是否开启健康检查
*/
EnableHealthCheck?: boolean;
/**
* 健康检查配置
*/
HealthCheck?: AIGWLLMHealthCheckSetting;
}
/**
* DescribeCloudNativeAPIGatewayServicesLight请求参数结构体
*/
export interface DescribeCloudNativeAPIGatewayServicesLightRequest {
/**
* 网关ID
*/
GatewayId: string;
/**
* 列表数量
*/
Limit?: number;
/**
* 列表 offset
*/
Offset?: number;
/**
* 过滤条件,多个过滤条件之间是与的关系,支持 id、name、upstreamType
*/
Filters?: Array;
}
/**
* PublishConfigFiles返回参数结构体
*/
export interface PublishConfigFilesResponse {
/**
* 配置文件发布是否成功
*/
Result?: boolean;
/**
* 配置文件发布Id
*/
ConfigFileReleaseId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpdateCloudNativeAPIGatewayCertificateInfo请求参数结构体
*/
export interface UpdateCloudNativeAPIGatewayCertificateInfoRequest {
/**
* 网关ID
*/
GatewayId: string;
/**
* 证书id
*/
Id: string;
/**
* 绑定的域名列表
*/
BindDomains?: Array;
/**
* 证书名称
*/
Name?: string;
}
/**
* 服务治理引擎绑定的kubernetes信息
*/
export interface BoundK8SInfo {
/**
* 绑定的kubernetes集群ID
*/
BoundClusterId: string;
/**
* 绑定的kubernetes的集群类型,分tke和eks两种
*/
BoundClusterType: string;
/**
* 服务同步模式,all为全量同步,demand为按需同步
*/
SyncMode?: string;
/**
* 绑定的kubernetes集群所在地域
*/
BindRegion?: string;
}
/**
* DescribeCloudNativeAPIGatewayCertificateDetails请求参数结构体
*/
export interface DescribeCloudNativeAPIGatewayCertificateDetailsRequest {
/**
* 网关ID
*/
GatewayId: string;
/**
* 证书Id
*/
Id: string;
}
/**
* 配置文件标签
*/
export interface ConfigFileTag {
/**
* key-value 键
*/
Key?: string;
/**
* key-value 值
*/
Value?: string;
}
/**
* 实例信息
*/
export interface GovernanceInstanceInput {
/**
* 实例所在服务名。
*/
Service: string;
/**
* 实例服务所在命名空间。
*/
Namespace: string;
/**
* 实例负载均衡权重信息。不填默认为100。
*/
Weight?: number;
/**
* 实例默认健康信息。不填默认为健康。
*/
Healthy?: boolean;
/**
* 实例隔离信息。不填默认为非隔离。
*/
Isolate?: boolean;
/**
* 实例ip。
*/
Host?: string;
/**
* 实例监听端口。
*/
Port?: number;
/**
* 实例使用协议。不填默认为空。
*/
Protocol?: string;
/**
* 实例版本。不填默认为空。
*/
InstanceVersion?: string;
/**
* 是否启用健康检查。不填默认不启用。
*/
EnableHealthCheck?: boolean;
/**
* 上报心跳时间间隔。若 EnableHealthCheck 为不启用,则此参数不生效;若 EnableHealthCheck 启用,此参数不填,则默认 ttl 为 5s。
*/
Ttl?: number;
}
/**
* CreateNativeGatewayServerGroup返回参数结构体
*/
export interface CreateNativeGatewayServerGroupResponse {
/**
* 网关分组创建信息
*/
Result?: CreateCloudNativeAPIGatewayServerGroupResult;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AddCloudNativeAPIGatewayConsumerGroupAuth请求参数结构体
*/
export interface AddCloudNativeAPIGatewayConsumerGroupAuthRequest {
/**
* 网关实例id
*/
GatewayId: string;
/**
* 授权资源类型。
枚举值:
- ModelAPI:模型 API
- MCPServer:MCP Server
*/
ResourceType: string;
/**
* 对应资源的 ID。
- ResourceType=ModelAPI 时是模型 API ID
- ResourceType=MCPServer 时是 MCP Server ID
*/
ResourceId: string;
/**
* 消费者组 ID 列表(每个 ID 以 cg- 开头),长度 1-10。
*/
ConsumerGroupIds: Array;
}
/**
* DeleteConfigFileReleases返回参数结构体
*/
export interface DeleteConfigFileReleasesResponse {
/**
* 删除配置发布结果
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyGovernanceInstances请求参数结构体
*/
export interface ModifyGovernanceInstancesRequest {
/**
* tse实例id。
*/
InstanceId: string;
/**
* 服务实例信息。
*/
GovernanceInstances: Array;
}
/**
* 治理中心命名空间
*/
export interface GovernanceNamespace {
/**
* 命名空间名称。
*/
Name?: string;
/**
* 命名空间描述信息。
*/
Comment?: string;
/**
* 创建时间。
*/
CreateTime?: string;
/**
* 修改时间。
*/
ModifyTime?: string;
/**
* 命名空间下总服务数据量
*/
TotalServiceCount?: number;
/**
* 命名空间下总健康实例数量
*/
TotalHealthInstanceCount?: number;
/**
* 命名空间下总实例数量
*/
TotalInstanceCount?: number;
/**
* 命名空间ID
*/
Id?: string;
/**
* 是否可以编辑
*/
Editable?: boolean;
/**
* 可以操作此命名空间的用户ID列表
*/
UserIds?: Array;
/**
* 可以操作此命名空间的用户组ID列表
*/
GroupIds?: Array;
/**
* 移除可以操作此命名空间的用户ID列表
*/
RemoveUserIds?: Array;
/**
* 移除可以操作此命名空间的用户组ID列表
*/
RemoveGroupIds?: Array;
/**
* 该命名空间下的服务对哪些命名空间可见
*/
ServiceExportTo?: Array;
/**
* 是否开启同步到全局注册中心
*/
SyncToGlobalRegistry?: boolean;
/**
* 元数据
*/
Metadatas?: Array;
}
/**
* ModifyCloudNativeAPIGatewayLLMModelService返回参数结构体
*/
export interface ModifyCloudNativeAPIGatewayLLMModelServiceResponse {
/**
* 是否成功
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteCloudNativeAPIGatewayCanaryRule返回参数结构体
*/
export interface DeleteCloudNativeAPIGatewayCanaryRuleResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteCloudNativeAPIGatewayIPRestriction返回参数结构体
*/
export interface DeleteCloudNativeAPIGatewayIPRestrictionResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpdateCloudNativeAPIGatewayCertificateInfo返回参数结构体
*/
export interface UpdateCloudNativeAPIGatewayCertificateInfoResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyNetworkBasicInfo返回参数结构体
*/
export interface ModifyNetworkBasicInfoResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateOrModifyCloudNativeAPIGatewayCORS请求参数结构体
*/
export interface CreateOrModifyCloudNativeAPIGatewayCORSRequest {
/**
* 网关ID
*/
GatewayId: string;
/**
* 跨域插件绑定的资源类型:route|service
*/
SourceType: string;
/**
* 路由或服务的id
*/
SourceId: string;
/**
* 是否启用插件
*/
Enabled: boolean;
/**
* 跨域 Access-Control-Allow-Origin
*/
Origins?: Array;
/**
* 跨域 Access-Control-Allow-Headers header
*/
Headers?: Array;
/**
* 跨域 Access-Control-Allow-Methods
*/
Methods?: Array;
/**
* 跨域 Access-Control-Expose-Headers
*/
ExposedHeaders?: Array;
/**
* preflight 请求缓存时间
*/
MaxAge?: number;
/**
* 跨域 Access-Control-Allow-Credentials
*/
Credentials?: boolean;
/**
* 是否把OPTIONS请求透传后端
*/
PreFlightContinue?: boolean;
}
/**
* DescribeCloudNativeAPIGateway返回参数结构体
*/
export interface DescribeCloudNativeAPIGatewayResponse {
/**
* 获取云原生API网关基础信息响应结果。
*/
Result?: DescribeCloudNativeAPIGatewayResult;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyCloudNativeAPIGatewayConsumerGroup返回参数结构体
*/
export interface ModifyCloudNativeAPIGatewayConsumerGroupResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateCloudNativeAPIGateway请求参数结构体
*/
export interface CreateCloudNativeAPIGatewayRequest {
/**
* 云原生API网关名字, 最多支持60个字符。
*/
Name: string;
/**
* 云原生API网关类型, 目前只支持kong。
*/
Type: string;
/**
* 云原生API网关版本。参考值:
- 2.4.1
- 2.5.1
*/
GatewayVersion: string;
/**
* 云原生API网关节点配置。
*/
NodeConfig: CloudNativeAPIGatewayNodeConfig;
/**
* 云原生API网关vpc配置。
*/
VpcConfig: CloudNativeAPIGatewayVpcConfig;
/**
* 云原生API网关描述信息, 最多支持120个字符。
*/
Description?: string;
/**
* 标签列表
*/
Tags?: Array;
/**
* 是否开启 CLS 日志。默认值:fasle
*/
EnableCls?: boolean;
/**
* 产品版本。参考值:
- TRIAL:开发版
- STANDARD:标准版 (默认值)
- PROFESSIONAL:专业版
*/
FeatureVersion?: string;
/**
* 公网出流量带宽,[1,2048]Mbps
*/
InternetMaxBandwidthOut?: number;
/**
* 实例实际的地域信息,默认值:ap-guangzhou
*/
EngineRegion?: string;
/**
* ingress Class名称
*/
IngressClassName?: string;
/**
* 付费类型。参考值:
0:后付费(默认值)
1:预付费(接口暂不支持创建预付费实例)
*/
TradeType?: number;
/**
* 公网相关配置
*/
InternetConfig?: InternetConfig;
/**
* 关联的prometheus ID
*/
PromId?: string;
}
/**
* 策略绑定的网关分组信息
*/
export interface CloudNativeAPIGatewayStrategyBindingGroupInfo {
/**
* 网关分组ID
*/
GroupId?: string;
/**
* 节点配置
*/
NodeConfig?: CloudNativeAPIGatewayNodeConfig;
/**
* 绑定时间
*/
BindTime?: string;
/**
* 网关分组名称
*/
GroupName?: string;
/**
* 绑定状态
*/
Status?: string;
}
/**
* DescribeGovernanceServiceContractVersions返回参数结构体
*/
export interface DescribeGovernanceServiceContractVersionsResponse {
/**
* 服务契约版本列表
*/
GovernanceServiceContractVersions?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 目标服务实例实例标签信息
*/
export interface RoutingDestinationRuleLabel {
/**
* 标签键
注意:此字段可能返回 null,表示取不到有效值。
*/
LabelKey?: string;
/**
* 标签值
注意:此字段可能返回 null,表示取不到有效值。
*/
LabelValue?: string;
/**
* 表达式类型
注意:此字段可能返回 null,表示取不到有效值。
*/
LabelType?: string;
/**
* 值类型
注意:此字段可能返回 null,表示取不到有效值。
*/
LabelValueType?: string;
}
/**
* DescribeCloudNativeAPIGatewaySecretKeyValue请求参数结构体
*/
export interface DescribeCloudNativeAPIGatewaySecretKeyValueRequest {
/**
* 实例 ID
*/
GatewayId: string;
/**
* 密钥id
*/
SecretKeyId: string;
}
/**
* AI 网关延迟优先路由模型服务
*/
export interface AIGWLatencyPriorityRouteRule {
/**
* 模型服务id
*/
ModelServiceId: string;
}
/**
* ModifyConfigFiles返回参数结构体
*/
export interface ModifyConfigFilesResponse {
/**
* 修改是否成功
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCloudNativeAPIGatewaySecretKey返回参数结构体
*/
export interface DescribeCloudNativeAPIGatewaySecretKeyResponse {
/**
* 密钥详情。
*/
Result?: CNAPIGwSecretKey;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeAllConfigFileTemplates返回参数结构体
*/
export interface DescribeAllConfigFileTemplatesResponse {
/**
* 数据总数量
*/
TotalCount?: number;
/**
* 配置文件模板列表
*/
ConfigFileTemplates?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 配置文件标签
*/
export interface ConfigFileGroupTag {
/**
* key-value 键
*/
Key?: string;
/**
* key-value 值
*/
Value?: string;
}
/**
* DescribeConfigFileReleaseVersions请求参数结构体
*/
export interface DescribeConfigFileReleaseVersionsRequest {
/**
* 实例id
*/
InstanceId: string;
/**
* 命名空间
*/
Namespace?: string;
/**
* 配置分组
*/
Group?: string;
/**
* 文件名称
*/
FileName?: string;
/**
* 配置文件ID
*/
ConfigFileId?: string;
}
/**
* DescribeCloudNativeAPIGatewaySecretKeyList返回参数结构体
*/
export interface DescribeCloudNativeAPIGatewaySecretKeyListResponse {
/**
* 密钥列表
*/
Result?: CNAPIGwSecretKeyList;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 服务契约版本信息
*/
export interface GovernanceServiceContractVersion {
/**
* 契约版本
*/
Version?: string;
/**
* 契约名称
*/
Name?: string;
/**
* 唯一名称
*/
Key?: string;
}
/**
* CreateCloudNativeAPIGatewayConsumerGroup请求参数结构体
*/
export interface CreateCloudNativeAPIGatewayConsumerGroupRequest {
/**
* 网关实例id
*/
GatewayId: string;
/**
* 消费者组名称,最长 60 字符。同一网关下唯一。
*/
Name: string;
/**
* 启用状态。
枚举值:
*/
Status: string;
/**
* 消费者组描述。最长 200 字符。
*/
Description?: string;
}
/**
* AI 网关日志输出配置
*/
export interface AIGWLogConfig {
/**
* 是否开启请求 payload 记录日志
*/
EnableRequestLogPayloads?: boolean;
/**
* 是否开启响应 payload 记录日志
*/
EnableResponseLogPayloads?: boolean;
/**
* 日志记录的请求body的最大字节数
取值范围:[512, 1048576]
EnableRequestLogPayloads 为true时必填
*/
RequestLogPayloadMaxSize?: number;
/**
* 日志记录的响应body的最大字节数
取值范围:[512, 1048576]
EnableResponseLogPayloads 为true时必填
*/
ResponseLogPayloadMaxSize?: number;
/**
* 请求 payload access log 输出模式
枚举值:
- raw: access log 中 body 记录客户端原始请求
- processed: access log 中 body 记录 AI 网关协议适配、改写、归一化后的 OpenAI-compatible 内容
*/
RequestLogPayloadMode?: string;
/**
* 上游原始 payload access log 输出模式
枚举值:
- raw: access log 中 body 记录客户端原始上游响应
- processed: access log 中 body 记录 AI 网关协议适配、改写、归一化后的 OpenAI-compatible 内容
*/
ResponseLogPayloadMode?: string;
/**
* 请求 Body 大小裁剪策略
枚举值:
- Bounded: 裁剪大小
- UnBounded: 不裁剪大小
*/
RequestLogPayloadTruncationPolicy?: string;
/**
* 响应 Body 大小裁剪策略
枚举值:
- Bounded: 裁剪大小
- UnBounded: 不裁剪大小
*/
ResponseLogPayloadTruncationPolicy?: string;
}
/**
* ModifyCloudNativeAPIGatewayRouteRateLimit请求参数结构体
*/
export interface ModifyCloudNativeAPIGatewayRouteRateLimitRequest {
/**
* 网关ID
*/
GatewayId: string;
/**
* 路由id,或路由名称。
不支持“未命名”
*/
Id: string;
/**
* 限流配置
*/
LimitDetail: CloudNativeAPIGatewayRateLimitDetail;
}
/**
* Kong网关主动健康检查配置
*/
export interface KongActiveHealthCheck {
/**
* 主动健康检查健康探测间隔,单位:秒,0表示不开启
*/
HealthyInterval?: number;
/**
* 主动健康检查异常探测间隔,单位:秒,0表示不开启
*/
UnHealthyInterval?: number;
/**
* 在 GET HTTP 请求中使用的路径,以作为主动运行状况检查的探测器运行。默认: ”/”。
*/
HttpPath?: string;
/**
* GET HTTP 请求的超时时间,单位:秒。默认 60。
*/
Timeout?: number;
/**
* Host头
*/
HostHeader?: string;
}
/**
* 云原生网关限流插件外部redis配置
*/
export interface ExternalRedis {
/**
* redis ip
*/
RedisHost: string;
/**
* redis密码
*/
RedisPassword: string;
/**
* redis端口
*/
RedisPort: number;
/**
* 超时时间 ms
*/
RedisTimeout: number;
}
/**
* ModifyCloudNativeAPIGatewayCertificate请求参数结构体
*/
export interface ModifyCloudNativeAPIGatewayCertificateRequest {
/**
* 网关ID
*/
GatewayId: string;
/**
* 证书id
*/
Id: string;
/**
* 证书名称,即将废弃
* @deprecated
*/
Name?: string;
/**
* 证书私钥,CertSource为native时必填。
*/
Key?: string;
/**
* 证书pem格式,CertSource为native时必填。
*/
Crt?: string;
/**
* 绑定的域名,即将废弃
* @deprecated
*/
BindDomains?: Array;
/**
* ssl平台证书 Id,CertSource为ssl时必填。
*/
CertId?: string;
/**
* 证书来源
- ssl (ssl平台证书),默认值
- native (kong自定义证书)
*/
CertSource?: string;
}
/**
* DeleteGovernanceAliases返回参数结构体
*/
export interface DeleteGovernanceAliasesResponse {
/**
* 创建是否成功。
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 治理中心服务信息。
*/
export interface GovernanceService {
/**
* 服务名称。
*/
Name?: string;
/**
* 命名空间名称。
*/
Namespace?: string;
/**
* 元数据信息数组。
*/
Metadatas?: Array;
/**
* 描述信息。
*/
Comment?: string;
/**
* 创建时间。
*/
CreateTime?: string;
/**
* 修改时间。
*/
ModifyTime?: string;
/**
* 服务所属部门。
*/
Department?: string;
/**
* 服务所属业务。
*/
Business?: string;
/**
* 健康服务实例数
*/
HealthyInstanceCount?: number;
/**
* 服务实例总数
*/
TotalInstanceCount?: number;
/**
* 服务ID
*/
Id?: string;
/**
* 是否可以编辑
*/
Editable?: boolean;
/**
* 可以编辑该资源的用户ID
*/
UserIds?: Array;
/**
* 可以编辑该资源的用户组ID
*/
GroupIds?: Array;
/**
* 移除可以编辑该资源的用户ID
*/
RemoveUserIds?: Array;
/**
* 移除可以编辑该资源的用户组ID
*/
RemoveGroupIds?: Array;
/**
* 该服务对哪些命名空间可见
*/
ExportTo?: Array;
/**
* 该服务信息摘要签名
*/
Revision?: string;
/**
* 是否开启同步到全局注册中心
*/
SyncToGlobalRegistry?: boolean;
/**
* 隔离实例数
*/
IsolateInstanceCount?: number;
/**
* 服务健康状态
*/
ServiceStatus?: number;
/**
* 服务类型
枚举值:
- 0: 微服务(默认)
- 1: MCP Server
- 2: AI Agent
*/
Type?: number;
}
/**
* DeleteAutoScalerResourceStrategy请求参数结构体
*/
export interface DeleteAutoScalerResourceStrategyRequest {
/**
* 网关实例ID
*/
GatewayId: string;
/**
* 策略ID
*/
StrategyId: string;
}
/**
* DescribeCloudNativeAPIGatewayConsumerGroup请求参数结构体
*/
export interface DescribeCloudNativeAPIGatewayConsumerGroupRequest {
/**
* 网关实例id
*/
GatewayId: string;
/**
* 消费者组ID
*/
ConsumerGroupId: string;
}
/**
* CreateGovernanceInstances返回参数结构体
*/
export interface CreateGovernanceInstancesResponse {
/**
* 创建是否成功。
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteCloudNativeAPIGatewayLLMModelAPI请求参数结构体
*/
export interface DeleteCloudNativeAPIGatewayLLMModelAPIRequest {
/**
* 网关 id。
*/
GatewayId: string;
/**
* 模型 API ID,全局唯一标识。
*/
ModelAPIId: string;
}
/**
* DescribeCNGWServicesWithRoutes返回参数结构体
*/
export interface DescribeCNGWServicesWithRoutesResponse {
/**
* 无
*/
Result?: KongServiceWithRoutes;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCloudNativeAPIGatewayLLMModelAPIs请求参数结构体
*/
export interface DescribeCloudNativeAPIGatewayLLMModelAPIsRequest {
/**
* 网关 id。
*/
GatewayId: string;
/**
* 每页条数,范围 [1, 1000],默认 10。
*/
Limit?: number;
/**
* 起始位置,从 0 开始。
*/
Offset?: number;
/**
* 过滤条件。当前未启用具体字段。
*/
Filters?: Array;
/**
* 模糊匹配模型 API 名称。
*/
Keyword?: string;
/**
* 消费者组 ID(以 cg- 开头),与 UseToBind 搭配使用。
*/
ConsumerGroupId?: string;
/**
* 是否用于绑定场景。true 时仅返回可被绑定到指定消费者组的模型 API。
*/
UseToBind?: boolean;
/**
* 消费者ID
*/
ConsumerId?: string;
}
/**
* 创建云原生网关服务结果
*/
export interface CreateGatewayServiceResult {
/**
* 网关服务ID
*/
ServiceId?: string;
}
/**
* 根据公网IP查询云原生网关实例信息出参
*/
export interface DescribeInstanceInfoByIpResult {
/**
* 实例id
*/
GatewayId?: string;
/**
* 分组id
*/
GroupId?: string;
}
/**
* CreateGovernanceLaneGroups返回参数结构体
*/
export interface CreateGovernanceLaneGroupsResponse {
/**
* 是否创建成功
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 创建资源通用结果
*/
export interface CNAPIGwCreateCommonResult {
/**
* 是否成功
*/
Success?: boolean;
/**
* 对应的id 值
*/
ID?: string;
}
/**
* 模型服务路由配置
*/
export interface CloudNativeAPIGatewayLLMModelServiceRoute {
/**
* 生效的路由算法类型:权重路由,模型名称路由、参数路由等Weighted/ModelName/Query (预留多个,暂时只能填写一个)
*/
SelectedTypes: Array;
/**
* 权重路由配置,最多10个
*/
WeightedConfig?: Array;
/**
* 模型名称路由配置,最多10个
*/
ModelNameConfig?: Array;
/**
* 意图识别
*/
IntentRouteConfig?: AIGWIntentRoute;
/**
* 延迟路由
*/
LatencyPriorityConfig?: AIGWLatencyPriorityConfig;
/**
* 缓存感知路由配置(前缀缓存)
*/
CacheAwareRouteConfig?: AIGWCacheAwareRouteConfig;
/**
* token 长度路由
*/
TokenLengthRouteConfig?: AIGWTokenLengthRoute;
}
/**
* 消费者组结构
*/
export interface CNAPIGwConsumerGroup {
/**
* 分组id
*/
ConsumerGroupId: string;
/**
* 名字
*/
Name: string;
/**
* 状态Disable/Enable
*/
Status: string;
/**
* 描述
*/
Description: string;
/**
* 创建时间
*/
CreateTime?: string;
/**
* 更新时间 yyyy-MM-dd hh:mm:ss
*/
ModifyTime?: string;
/**
* 绑定的消费者数量
注意:此字段可能返回 null,表示取不到有效值。
*/
BindCount?: number;
/**
* 同步状态
枚举值:
*/
SyncStatus?: string;
/**
* 资源类型
枚举值:
*/
SourceType?: string;
/**
* 同步版本
*/
SyncedVersion?: string;
}
/**
* 新增Location字段,展示zone/region/campus
*/
export interface Location {
/**
* 大区
*/
Region?: string;
/**
* 可用区
*/
Zone?: string;
/**
* 机房
*/
Campus?: string;
}
/**
* 查询跨域配置出参
*/
export interface DescribeKongCORSResult {
/**
* 资源类型
*/
SourceType?: string;
/**
* 资源id
*/
SourceId?: string;
/**
* 是否启用
*/
Enabled?: boolean;
/**
* 跨域 Origins
*/
Origins?: Array;
/**
* 跨域 Headers
*/
Headers?: Array;
/**
* 跨域 Methods
*/
Methods?: Array;
/**
* 跨域 ExposedHeaders
*/
ExposedHeaders?: Array;
/**
* 跨域OPTIONS请求缓存时间
*/
MaxAge?: number;
/**
* 跨域请求是否允许携带身份信息
*/
Credentials?: boolean;
/**
* 跨域请求是否透传后端
*/
PreFlightContinue?: boolean;
}
/**
* ModifyCloudNativeAPIGatewayCanaryRule请求参数结构体
*/
export interface ModifyCloudNativeAPIGatewayCanaryRuleRequest {
/**
* 网关 ID
*/
GatewayId: string;
/**
* 服务 ID
*/
ServiceId: string;
/**
* 优先级,同一个服务的灰度规则优先级是唯一的
*/
Priority?: number;
/**
* 灰度规则配置
*/
CanaryRule?: CloudNativeAPIGatewayCanaryRule;
/**
* 灰度规则配置列表,如果配置了此参数,将以此参数为准,忽略Priority和CanaryRule参数
*/
CanaryRuleList?: Array;
}
/**
* DescribeCloudNativeAPIGatewayPorts返回参数结构体
*/
export interface DescribeCloudNativeAPIGatewayPortsResponse {
/**
* 云原生API网关实例协议端口列表响应结果
*/
Result?: DescribeGatewayInstancePortResult;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 网关服务信息匹配条件
*/
export interface TSEGatewaySelector {
/**
* 网关引擎实例ID
注意:此字段可能返回 null,表示取不到有效值。
*/
GatewayId: string;
/**
* 网关服务
注意:此字段可能返回 null,表示取不到有效值。
*/
Services?: Array;
}
/**
* DeleteGovernanceNamespaces请求参数结构体
*/
export interface DeleteGovernanceNamespacesRequest {
/**
* tse 实例 id。
*/
InstanceId: string;
/**
* 命名空间信息。
*/
GovernanceNamespaces: Array;
}
/**
* DescribeCloudNativeAPIGatewayConfig返回参数结构体
*/
export interface DescribeCloudNativeAPIGatewayConfigResponse {
/**
* 获取云原生API网关响应结果。
*/
Result?: DescribeCloudNativeAPIGatewayConfigResult;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* OIDC 凭证物料配置
*/
export interface AIGWOIDCCredentialConfig {
/**
* IdP 注册的 client_id
*/
ClientId: string;
/**
* IdP 注册的 client_secret
*/
ClientSecret: string;
/**
* IdP Issuer URL
*/
IssuerURL: string;
/**
* IdP 中该用户的 claim 值
*/
ConsumerClaimValue?: string;
}
/**
* CreateCloudNativeAPIGatewayConsumerGroup返回参数结构体
*/
export interface CreateCloudNativeAPIGatewayConsumerGroupResponse {
/**
* 创建结果。包含成功标识与新建资源 ID。
*/
Result?: CNAPIGwCreateCommonResult;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCloudNativeAPIGatewayLLMModelAPI返回参数结构体
*/
export interface DescribeCloudNativeAPIGatewayLLMModelAPIResponse {
/**
* 模型 API 信息。
*/
Result?: CloudNativeAPIGatewayLLMModelAPI;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateCloudNativeAPIGatewayRoute返回参数结构体
*/
export interface CreateCloudNativeAPIGatewayRouteResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteConfigFiles返回参数结构体
*/
export interface DeleteConfigFilesResponse {
/**
* 修改是否成功
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 引擎地域配置详情
*/
export interface EngineRegionInfo {
/**
* 引擎节点所在地域
*/
EngineRegion: string;
/**
* 此地域节点分配数量
*/
Replica: number;
/**
* 集群网络信息
*/
VpcInfos: Array;
/**
* Polaris: 是否为主地域
Zookeeper: 是否为Leader固定地域
*/
MainRegion?: boolean;
/**
* 引擎规格ID
*/
SpecId?: string;
}
/**
* 配置发布删除
*/
export interface ConfigFileReleaseDeletion {
/**
* 命名空间
*/
Namespace?: string;
/**
* 配置分组
*/
Group?: string;
/**
* 文件名称
*/
FileName?: string;
/**
* 发布版本
*/
ReleaseVersion?: string;
/**
* 配置发布ID
*/
Id?: number;
}
/**
* DescribeCloudNativeAPIGatewayServiceRateLimit返回参数结构体
*/
export interface DescribeCloudNativeAPIGatewayServiceRateLimitResponse {
/**
* 获取云原生网关限流插件(服务)
*/
Result?: CloudNativeAPIGatewayRateLimitDetail;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyGovernanceNamespaces请求参数结构体
*/
export interface ModifyGovernanceNamespacesRequest {
/**
* tse实例id。
*/
InstanceId: string;
/**
* 命名空间信息。
*/
GovernanceNamespaces: Array;
}
/**
* ModifyGovernanceAlias返回参数结构体
*/
export interface ModifyGovernanceAliasResponse {
/**
* 创建是否成功。
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 获取云原生API网关实例策略绑定网关分组列表响应结果。
*/
export interface ListCloudNativeAPIGatewayStrategyBindingGroupInfoResult {
/**
* 数量
*/
TotalCount: number;
/**
* 云原生API网关实例策略绑定网关分组列表
*/
GroupInfos: Array;
}
/**
* 缓存感知路由候选模型服务
*/
export interface AIGWCacheAwareRouteCandidate {
/**
* 模型服务ID
*/
ModelServiceId?: string;
/**
* 模型服务名称
*/
ModelServiceName?: string;
}
/**
* DeleteGovernanceInstancesByHost请求参数结构体
*/
export interface DeleteGovernanceInstancesByHostRequest {
/**
* tse实例id。
*/
InstanceId: string;
/**
* 要删除的服务实例信息。
*/
GovernanceInstances: Array;
}
/**
* DescribeCloudNativeAPIGatewayIPRestriction返回参数结构体
*/
export interface DescribeCloudNativeAPIGatewayIPRestrictionResponse {
/**
* 出参
注意:此字段可能返回 null,表示取不到有效值。
*/
Result?: DescribeKongIpRestrictionResult;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateCloudNativeAPIGatewayRouteRateLimit返回参数结构体
*/
export interface CreateCloudNativeAPIGatewayRouteRateLimitResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCloudNativeAPIGateways返回参数结构体
*/
export interface DescribeCloudNativeAPIGatewaysResponse {
/**
* 获取云原生API网关实例列表响应结果。
*/
Result?: ListCloudNativeAPIGatewayResult;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateGovernanceNamespaces返回参数结构体
*/
export interface CreateGovernanceNamespacesResponse {
/**
* 操作是否成功。
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteCloudNativeAPIGatewayConsumer返回参数结构体
*/
export interface DeleteCloudNativeAPIGatewayConsumerResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 云原生网关健康检查配置
*/
export interface UpstreamHealthCheckConfig {
/**
* 开启主动健康检查
*/
EnableActiveHealthCheck?: boolean;
/**
* 主动健康检查配置
*/
ActiveHealthCheck?: KongActiveHealthCheck;
/**
* 开启被动健康检查
*/
EnablePassiveHealthCheck?: boolean;
/**
* 被动健康检查配置
*/
PassiveHealthCheck?: KongPassiveHealthCheck;
/**
* 连续健康阈值,单位:次
*/
Successes?: number;
/**
* 连续异常阈值,单位:次
*/
Failures?: number;
/**
* 超时阈值,单位:次
*/
Timeouts?: number;
/**
* 健康HTTP状态码
*/
HealthyHttpStatuses?: Array;
/**
* 异常HTTP状态码
*/
UnhealthyHttpStatuses?: Array;
/**
* 健康检查监控上报的数据屏蔽权重为0的节点
注意:此字段可能返回 null,表示取不到有效值。
* @deprecated
*/
IgnoreZeroWeightNodes?: boolean;
/**
* 健康检查支持权重为0节点
*/
ZeroWeightHeathCheck?: boolean;
}
/**
* DescribeCloudNativeAPIGatewayLLMModelServices请求参数结构体
*/
export interface DescribeCloudNativeAPIGatewayLLMModelServicesRequest {
/**
* 网关 id。
*/
GatewayId: string;
/**
* 返回数量,默认为 10,最大值为 1000。
*/
Limit?: number;
/**
* 偏移量,默认为 0。
*/
Offset?: number;
/**
* 过滤条件,多个过滤条件之间是“与”的关系,支持 Name
*/
Filters?: Array;
/**
* 通过模型 API 筛选模型服务
*/
ModelAPIId?: string;
/**
* 通过密匙查询绑定的模型服务
*/
SecretKeyId?: string;
/**
* 搜索关键词,模糊匹配 name 和 description
*/
Keyword?: string;
}
/**
* Zookeeper副本信息
*/
export interface ZookeeperReplica {
/**
* 名称
*/
Name?: string;
/**
* 角色
*/
Role?: string;
/**
* 状态
*/
Status?: string;
/**
* 子网ID
*/
SubnetId?: string;
/**
* 可用区ID
*/
Zone?: string;
/**
* 可用区ID
*/
ZoneId?: string;
/**
* 别名
*/
AliasName?: string;
/**
* VPC ID
*/
VpcId?: string;
}
/**
* DeleteAutoScalerResourceStrategy返回参数结构体
*/
export interface DeleteAutoScalerResourceStrategyResponse {
/**
* 是否成功
*/
Result: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeOneCloudNativeAPIGatewayService请求参数结构体
*/
export interface DescribeOneCloudNativeAPIGatewayServiceRequest {
/**
* 网关ID
*/
GatewayId: string;
/**
* 服务名字,或服务ID
*/
Name: string;
}
/**
* AI网关消费者模型范围
*/
export interface AIGWConsumerModelScope {
/**
* 消费者模型生效范围类型
枚举值:
- INHERIT: 继承所在消费者组的生效模型范围
- ALLOWLIST: 自定义白名单,必须 ⊆ 所在组针对该资源的生效模型集合
*/
ScopeType?: string;
/**
* 模型授权白名单列表
*/
AllowList?: Array;
}
/**
* DescribeCloudNativeAPIGatewayLLMModelAPIs返回参数结构体
*/
export interface DescribeCloudNativeAPIGatewayLLMModelAPIsResponse {
/**
* 模型 API 列表。
*/
Result?: ListCloudNativeAPIGatewayLLMModelAPI;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 云原生网关模型LLM配额限制信息
*/
export interface AIGWLLMQuotaLimit {
/**
* 该模型服务每分钟请求数上限,0 表示该维度不限
*/
RPMLimit?: number;
/**
* 该模型服务每分钟 Token 数上限,0 表示该维度不限
*/
TPMLimit?: number;
/**
* 并发限流数
*/
ConcurrentCountLimit?: number;
}
/**
* DeleteGovernanceAliases请求参数结构体
*/
export interface DeleteGovernanceAliasesRequest {
/**
* tse实例id。
*/
InstanceId: string;
/**
* 服务别名列表
*/
GovernanceAliases: Array;
}
/**
* 证书信息
*/
export interface CertificateInfo {
/**
* 唯一id
*/
Id?: string;
}
/**
* DescribeCloudNativeAPIGatewayConsumerList返回参数结构体
*/
export interface DescribeCloudNativeAPIGatewayConsumerListResponse {
/**
* 消费者列表
*/
Result?: CNAPIGwConsumerList;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateOrModifyCloudNativeAPIGatewayIPRestriction请求参数结构体
*/
export interface CreateOrModifyCloudNativeAPIGatewayIPRestrictionRequest {
/**
* 网关ID
*/
GatewayId: string;
/**
* 访问控制插件绑定的资源类型:route|service
*/
SourceType: string;
/**
* 路由或服务的id
*/
SourceId: string;
/**
* 是否启用插件
*/
Enabled: boolean;
/**
* 访问控制类型:whiteList|blackList
*/
RestrictionType: string;
/**
* cidr|ip
*/
AddressList: Array;
}
/**
* LLM 模型服务列表
*/
export interface ListCloudNativeAPIGatewayLLMModelService {
/**
* 模型服务数量。
*/
TotalCount?: number;
/**
* 模型服务列表。
*/
DataList?: Array;
}
/**
* DescribeWafDomains请求参数结构体
*/
export interface DescribeWafDomainsRequest {
/**
* 网关ID
*/
GatewayId: string;
}
/**
* ModifyUpstreamNodeStatus返回参数结构体
*/
export interface ModifyUpstreamNodeStatusResponse {
/**
* 是否成功
注意:此字段可能返回 null,表示取不到有效值。
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* OpenWafProtection返回参数结构体
*/
export interface OpenWafProtectionResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 云原生网关模型API 配额降级触发条件信息
*/
export interface AIGWLLMQuotaFallbackTrigger {
/**
* 配额感知阈值百分比(RPM 与 TPM 共用)
取值范围:[0, 99]
*/
ThresholdPercent?: number;
/**
* 检查维度策略
枚举值:
- AnyInsufficient: RPM 或 TPM 任一不足即触发
- AllInsufficient: RPM 和 TPM 同时不足才触发
*/
CheckDimension?: string;
}
/**
* DescribeCloudNativeAPIGatewayRouteRateLimit返回参数结构体
*/
export interface DescribeCloudNativeAPIGatewayRouteRateLimitResponse {
/**
* 获取云原生网关限流插件(路由)
*/
Result?: CloudNativeAPIGatewayRateLimitDetail;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AddCloudNativeAPIGatewayConsumerGroupAuth返回参数结构体
*/
export interface AddCloudNativeAPIGatewayConsumerGroupAuthResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCloudNativeAPIGateway请求参数结构体
*/
export interface DescribeCloudNativeAPIGatewayRequest {
/**
* 云原生API网关实例ID
*/
GatewayId: string;
}
/**
* DeleteConfigFileGroup请求参数结构体
*/
export interface DeleteConfigFileGroupRequest {
/**
* tse 实例 id。
*/
InstanceId: string;
/**
* 命名空间
*/
Namespace: string;
/**
* 组
*/
Group: string;
}
/**
* kong证书列表
*/
export interface KongCertificatesList {
/**
* 证书列表总数
*/
Total?: number;
/**
* 无
注意:此字段可能返回 null,表示取不到有效值。
*/
CertificatesList?: Array;
/**
* 证书列表总页数
注意:此字段可能返回 null,表示取不到有效值。
* @deprecated
*/
Pages?: number;
}
/**
* 云原生网关限流插件Qps阈值
*/
export interface QpsThreshold {
/**
* qps阈值控制维度,包含:second、minute、hour、day、month、year
*/
Unit: string;
/**
* 阈值
*/
Max: number;
}
/**
* CreateCloudNativeAPIGatewayCanaryRule请求参数结构体
*/
export interface CreateCloudNativeAPIGatewayCanaryRuleRequest {
/**
* 网关 ID
*/
GatewayId: string;
/**
* 服务 ID
*/
ServiceId: string;
/**
* 灰度规则配置
*/
CanaryRule?: CloudNativeAPIGatewayCanaryRule;
/**
* 灰度规则配置列表,如果配置了此参数,将以此参数为准,忽略CanaryRule参数
*/
CanaryRuleList?: Array;
}
/**
* OpenWafProtection请求参数结构体
*/
export interface OpenWafProtectionRequest {
/**
* 网关ID
*/
GatewayId: string;
/**
* 防护资源的类型。
- Global 实例
- Service 服务
- Route 路由
- Object 对象(接口暂不支持)
*/
Type: string;
/**
* 当资源类型 Type 是 Service 或 Route 的时候,传入的服务或路由的列表
*/
List?: Array;
}
/**
* 治理中心实例信息。
*/
export interface GovernanceInstance {
/**
* 实例id。
*/
Id?: string;
/**
* 实例所在服务名。
*/
Service?: string;
/**
* 实例所在命名空间名。
*/
Namespace?: string;
/**
* 实例ip地址。
*/
Host?: string;
/**
* 实例端口信息。
*/
Port?: number;
/**
* 通信协议。
*/
Protocol?: string;
/**
* 版本信息。
*/
Version?: string;
/**
* 负载均衡权重。
*/
Weight?: number;
/**
* 是否开启健康检查。
*/
EnableHealthCheck?: boolean;
/**
* 实例是否健康。
*/
Healthy?: boolean;
/**
* 实例是否隔离。
*/
Isolate?: boolean;
/**
* 实例创建时间。
*/
CreateTime?: string;
/**
* 实例修改时间。
*/
ModifyTime?: string;
/**
* 元数据数组。
*/
Metadatas?: Array;
/**
* 上报心跳间隔。
*/
Ttl?: number;
/**
* 版本信息。
*/
InstanceVersion?: string;
/**
* 状态信息
*/
HealthStatus?: string;
/**
* 描述
*/
Comment?: string;
}
/**
* DeleteCloudNativeAPIGatewaySecretKey返回参数结构体
*/
export interface DeleteCloudNativeAPIGatewaySecretKeyResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCloudNativeAPIGatewayRoutes请求参数结构体
*/
export interface DescribeCloudNativeAPIGatewayRoutesRequest {
/**
* 网关ID
*/
GatewayId: string;
/**
* 翻页单页查询限制数量[0,1000], 默认值0
*/
Limit?: number;
/**
* 翻页单页偏移量,默认值0
*/
Offset?: number;
/**
* 服务的名字,精确匹配
*/
ServiceName?: string;
/**
* 路由的名字,精确匹配
*/
RouteName?: string;
/**
* 过滤条件,多个过滤条件之间是与的关系,支持 name, path, host, method, service, protocol
*/
Filters?: Array;
/**
* 路由类型
*/
RouteTypes?: Array;
/**
* 是否将灰度规则可能带来的路由排在原始路由前
*/
GrayRoutesFirst?: boolean;
/**
* 排序字段
*/
OrderField?: string;
/**
* 排序方式
枚举值:
*/
OrderType?: string;
}
/**
* CreateEngine返回参数结构体
*/
export interface CreateEngineResponse {
/**
* 引擎实例 ID
*/
InstanceId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 配置文件组
*/
export interface ConfigFileGroup {
/**
* 配置文件组id
*/
Id?: number;
/**
* 配置文件组名称
*/
Name?: string;
/**
* 命名空间
*/
Namespace?: string;
/**
* 备注
*/
Comment?: string;
/**
* 创建时间
*/
CreateTime?: string;
/**
* 创建者
*/
CreateBy?: string;
/**
* 修改时间
*/
ModifyTime?: string;
/**
* 修改者
*/
ModifyBy?: string;
/**
* 文件数
*/
FileCount?: number;
/**
* 关联用户,link_users
*/
UserIds?: Array;
/**
* 组id,link_groups
*/
GroupIds?: Array;
/**
* remove_link_users
*/
RemoveUserIds?: Array;
/**
* remove_link_groups
*/
RemoveGroupIds?: Array;
/**
* 是否可编辑
*/
Editable?: boolean;
/**
* 归属者
*/
Owner?: string;
/**
* 部门
*/
Department?: string;
/**
* 业务
*/
Business?: string;
/**
* 配置文件组标签
*/
ConfigFileGroupTags?: Array;
}
/**
* 获取网关节点信息
*/
export interface DescribeCloudNativeAPIGatewayNodesResult {
/**
* 获取云原生API网关节点列表响应结果。
*/
TotalCount: number;
/**
* 云原生API网关节点列表。
*/
NodeList: Array;
}
/**
* DescribeCloudNativeAPIGatewayLLMModelAPI请求参数结构体
*/
export interface DescribeCloudNativeAPIGatewayLLMModelAPIRequest {
/**
* 网关 id。
*/
GatewayId: string;
/**
* 模型 API ID,全局唯一标识。
*/
ModelAPIId: string;
}
/**
* DescribeNacosServerInterfaces请求参数结构体
*/
export interface DescribeNacosServerInterfacesRequest {
/**
* 实例id
*/
InstanceId?: string;
/**
* 返回的列表个数
*/
Limit?: number;
/**
* 返回的列表起始偏移量
*/
Offset?: number;
}
/**
* ModifyCloudNativeAPIGatewayConsumerGroup请求参数结构体
*/
export interface ModifyCloudNativeAPIGatewayConsumerGroupRequest {
/**
* 网关实例id
*/
GatewayId: string;
/**
* 消费者组 ID(以 cg- 开头)。
*/
ConsumerGroupId: string;
/**
* 消费者组名称,最长 60 字符。
*/
Name: string;
/**
* 启用状态。
枚举值:
*/
Status: string;
/**
* 消费者组描述。最长 200 字符。
*/
Description?: string;
}
/**
* AI网关 Query Param 凭证物料配置
*/
export interface AIGWQueryParamCredentialConfig {
/**
* 参数名
*/
ParamName?: string;
/**
* 参数值
*/
ParamValue?: string;
}
/**
* DescribeCloudNativeAPIGatewayCORS返回参数结构体
*/
export interface DescribeCloudNativeAPIGatewayCORSResponse {
/**
* 出参
注意:此字段可能返回 null,表示取不到有效值。
*/
Result?: DescribeKongCORSResult;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RemoveCloudNativeAPIGatewayConsumerGroupAuth请求参数结构体
*/
export interface RemoveCloudNativeAPIGatewayConsumerGroupAuthRequest {
/**
* 网关实例id
*/
GatewayId: string;
/**
* 授权资源类型。
枚举值:
- ModelAPI:模型 API
- MCPServer:MCP Server
*/
ResourceType: string;
/**
* 对应资源的 ID。
- ResourceType=ModelAPI 时是模型 API ID
- ResourceType=MCPServer 时是 MCP Server ID
*/
ResourceId: string;
/**
* 消费者组 ID 列表(每个 ID 以 cg- 开头),长度 1-10。
*/
ConsumerGroupIds: Array;
}
/**
* 延迟优先路由配置
*/
export interface AIGWLatencyPriorityConfig {
/**
* 路由规则列表
*/
Rules: Array;
/**
* 延迟指标
枚举值:
- LLMLatency: LLM 延迟
- NetworkLatency: 网络延迟
*/
LatencyMetric: string;
/**
* 路由策略
枚举值:
- FastMode: 快速模式
- BalanceMode: 均衡模式
*/
RouteMode?: string;
}
/**
* 服务的后端配置
*/
export interface KongUpstreamInfo {
/**
* IP或域名
*/
Host?: string;
/**
* 端口
*/
Port?: number;
/**
* 服务来源ID
*/
SourceID?: string;
/**
* 命名空间
*/
Namespace?: string;
/**
* 服务(注册中心或Kubernetes中的服务)名字
*/
ServiceName?: string;
/**
* 服务后端类型是IPList时提供
注意:此字段可能返回 null,表示取不到有效值。
*/
Targets?: Array;
/**
* 服务来源类型
*/
SourceType?: string;
/**
* SCF函数类型
*/
ScfType?: string;
/**
* SCF函数命名空间
*/
ScfNamespace?: string;
/**
* SCF函数名
*/
ScfLambdaName?: string;
/**
* SCF函数版本
*/
ScfLambdaQualifier?: string;
/**
* 冷启动时间,单位秒
*/
SlowStart?: number;
/**
* 负载均衡算法,默认为 round-robin,还支持 least-connections,consisten_hashing
*/
Algorithm?: string;
/**
* CVM弹性伸缩组ID
*/
AutoScalingGroupID?: string;
/**
* CVM弹性伸缩组端口
*/
AutoScalingCvmPort?: number;
/**
* CVM弹性伸缩组使用的CVM TAT命令状态
*/
AutoScalingTatCmdStatus?: string;
/**
* CVM弹性伸缩组生命周期挂钩状态
*/
AutoScalingHookStatus?: string;
/**
* 服务来源的名字
*/
SourceName?: string;
/**
* 精确的服务来源类型,新建服务来源时候传入的类型
*/
RealSourceType?: string;
/**
* upstream健康状态HEALTHY(健康), UNHEALTHY(异常), HEALTHCHECKS_OFF(未开启)和NONE(不支持健康检查)
*/
HealthStatus?: string;
/**
* 云函数是否开启CAM鉴权,不填时默认为开启(true)
*/
ScfCamAuthEnable?: boolean;
/**
* 云函数是否开启Base64编码,默认为false
*/
ScfIsBase64Encoded?: boolean;
/**
* 云函数是否开启响应集成,默认为false
*/
ScfIsIntegratedResponse?: boolean;
}
/**
* DescribeSREInstances请求参数结构体
*/
export interface DescribeSREInstancesRequest {
/**
* 请求过滤参数
*/
Filters?: Array;
/**
* 翻页单页查询限制数量[0,1000], 默认值0
*/
Limit?: number;
/**
* 翻页单页偏移量,默认值0
*/
Offset?: number;
/**
* 查询类型
*/
QueryType?: string;
/**
* 调用方来源
*/
QuerySource?: string;
}
/**
* 泳道入口信息
*/
export interface LaneTrafficEntry {
/**
* // type == "polarismesh.cn/gateway/tse-gateway, 则 selector 为 TSEGatewaySelector
// type == "polarismesh.cn/gateway/spring-cloud-gateway", 则 selector 为 ServiceGatewaySelector
// type == "polarismesh.cn/service, 则 selector 为 ServiceSelector
注意:此字段可能返回 null,表示取不到有效值。
*/
EntryType?: string;
/**
* TSE云原生网关选择器
注意:此字段可能返回 null,表示取不到有效值。
*/
TSEGatewaySelector?: TSEGatewaySelector;
/**
* 微服务网关选择器
注意:此字段可能返回 null,表示取不到有效值。
*/
ServiceGatewaySelector?: ServiceGatewaySelector;
/**
* 普通微服务选择器
注意:此字段可能返回 null,表示取不到有效值。
*/
ServiceSelector?: ServiceSelector;
}
/**
* DescribeCloudNativeAPIGatewayInfoByIp请求参数结构体
*/
export interface DescribeCloudNativeAPIGatewayInfoByIpRequest {
/**
* 云原生网关的公网ip
*/
PublicNetworkIP: string;
}
/**
* DescribeZookeeperReplicas返回参数结构体
*/
export interface DescribeZookeeperReplicasResponse {
/**
* 注册引擎实例副本信息
*/
Replicas?: Array;
/**
* 副本个数
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyConfigFileGroup请求参数结构体
*/
export interface ModifyConfigFileGroupRequest {
/**
* tse实例id
*/
InstanceId: string;
/**
* 配置文件组
*/
ConfigFileGroup: ConfigFileGroup;
}
/**
* DescribePublicAddressConfig返回参数结构体
*/
export interface DescribePublicAddressConfigResponse {
/**
* 公网地址信息
*/
Result?: DescribePublicAddressConfigResult;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AI GW Sensitive Word Route
*/
export interface AIGWSensitiveWordRoute {
/**
* 是否开启敏感词路由
*/
Enabled?: boolean;
/**
* 目标模型服务列表
*/
ModelServiceRefs?: Array;
/**
* 目标模型服务名,查询的时候会填充
*/
ModelServiceNames?: Array;
/**
* 路由方法
枚举值:
- Weighted: 权重路由
- ModelName: 按模型名称路由
*/
SelectedTypes?: Array;
/**
* 权重路由配置
*/
WeightedConfig?: Array;
/**
* 模型名称路由权重
*/
ModelNameConfig?: Array;
}
/**
* PublishConfigFiles请求参数结构体
*/
export interface PublishConfigFilesRequest {
/**
* TSE实例id
*/
InstanceId: string;
/**
* 配置文件发布
*/
ConfigFileReleases: ConfigFileRelease;
/**
* 控制开启校验配置版本是否已经存在
*/
StrictEnable?: boolean;
}
/**
* aksk类型密钥
*/
export interface AIGWAKSKCredentialConfig {
/**
* AccessKeyId
*/
AccessKeyId?: string;
/**
* SecretAccessKey
*/
SecretAccessKey?: string;
}
/**
* DescribeConfigFileReleaseHistories请求参数结构体
*/
export interface DescribeConfigFileReleaseHistoriesRequest {
/**
* TSE实例id
*/
InstanceId: string;
/**
* 命名空间
*/
Namespace?: string;
/**
* 组
*/
Group?: string;
/**
* 名称
*/
Name?: string;
/**
* 发布历史记录id,用于分页优化,一般指定 EndId,就不用指定 Offset,否则分页可能不连续
*/
EndId?: number;
/**
* 配置文件ID
*/
ConfigFileId?: string;
/**
* 返回数量,默认为20,最大值为100。
*/
Limit?: number;
/**
* 偏移量,默认为0。
*/
Offset?: number;
}
/**
* ModifyCloudNativeAPIGateway请求参数结构体
*/
export interface ModifyCloudNativeAPIGatewayRequest {
/**
* 云原生API网关实例ID。
*/
GatewayId: string;
/**
* 云原生API网关名字, 最多支持60个字符。
*/
Name?: string;
/**
* 云原生API网关描述信息, 最多支持120个字符。
*/
Description?: string;
/**
* 是否开启 CLS 日志。暂时取值只能是 true,即只能从关闭状态变成开启状态。
*/
EnableCls?: boolean;
/**
* 公网计费模式。可选取值 BANDWIDTH | TRAFFIC ,表示按带宽和按流量计费。
*/
InternetPayMode?: string;
/**
* 是否开启实例删除保护,默认false
*/
DeleteProtect?: boolean;
}
/**
* 泳道组
*/
export interface GovernanceLaneGroup {
/**
* 泳道名称
注意:此字段可能返回 null,表示取不到有效值。
*/
Name: string;
/**
* 泳道组ID
注意:此字段可能返回 null,表示取不到有效值。
*/
ID?: string;
/**
* 泳道入口服务列表
注意:此字段可能返回 null,表示取不到有效值。
*/
TrafficEntries?: Array;
/**
* 泳道服务列表
注意:此字段可能返回 null,表示取不到有效值。
*/
Destinations?: Array;
/**
* 泳道组描述
注意:此字段可能返回 null,表示取不到有效值。
*/
Description?: string;
/**
* 该泳道组下的所有泳道规则列表
注意:此字段可能返回 null,表示取不到有效值。
*/
Rules?: Array;
/**
* 规则内容摘要
注意:此字段可能返回 null,表示取不到有效值。
*/
Revision?: string;
/**
* 创建时间
注意:此字段可能返回 null,表示取不到有效值。
*/
CreateTime?: string;
/**
* 修改时间
注意:此字段可能返回 null,表示取不到有效值。
*/
ModifyTime?: string;
/**
* 规则一致性状态
注意:此字段可能返回 null,表示取不到有效值。
*/
Consistency?: string;
}
/**
* DescribeNativeGatewayServerGroups返回参数结构体
*/
export interface DescribeNativeGatewayServerGroupsResponse {
/**
* 分组列表信息
*/
Result?: NativeGatewayServerGroups;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyNativeGatewayServerGroup返回参数结构体
*/
export interface ModifyNativeGatewayServerGroupResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteCloudNativeAPIGatewayLLMModelService请求参数结构体
*/
export interface DeleteCloudNativeAPIGatewayLLMModelServiceRequest {
/**
* 网关 id。
*/
GatewayId: string;
/**
* 模型服务 ID,全局唯一标识。
*/
ModelServiceId: string;
}
/**
* DeleteCloudNativeAPIGatewayConsumerGroup返回参数结构体
*/
export interface DeleteCloudNativeAPIGatewayConsumerGroupResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeNativeGatewayServiceSources返回参数结构体
*/
export interface DescribeNativeGatewayServiceSourcesResponse {
/**
* 总实例数
*/
Total?: number;
/**
* 服务来源实例列表
*/
List?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 获取云原生API网关实例列表响应结果。
*/
export interface ListCloudNativeAPIGatewayResult {
/**
* 总数。
*/
TotalCount: number;
/**
* 云原生API网关实例列表。
*/
GatewayList: Array;
}
/**
* CreateCloudNativeAPIGatewayService返回参数结构体
*/
export interface CreateCloudNativeAPIGatewayServiceResponse {
/**
* 网关服务创建结果
*/
Result?: CreateGatewayServiceResult;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyGovernanceLaneGroups返回参数结构体
*/
export interface ModifyGovernanceLaneGroupsResponse {
/**
* 是否创建成功
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 密钥列表
*/
export interface CNAPIGwSecretKeyList {
/**
* 总数
*/
TotalCount?: number;
/**
* 密钥列表
*/
SecretKeys?: Array;
}
/**
* DeleteCloudNativeAPIGatewayRouteRateLimit返回参数结构体
*/
export interface DeleteCloudNativeAPIGatewayRouteRateLimitResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateOrModifyCloudNativeAPIGatewayCORS返回参数结构体
*/
export interface CreateOrModifyCloudNativeAPIGatewayCORSResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeConfigFileGroups请求参数结构体
*/
export interface DescribeConfigFileGroupsRequest {
/**
* tse实例id
*/
InstanceId: string;
/**
* 根据命名空间过滤
*/
Namespace?: string;
/**
* 根据配置文件组名过滤
*/
Group?: string;
/**
* 根据配置文件组名过滤
*/
FileName?: string;
/**
* 返回数量,默认为20,最大值为100。
*/
Limit?: number;
/**
* 偏移量,默认为0。
*/
Offset?: number;
}
/**
* CreateGovernanceNamespaces请求参数结构体
*/
export interface CreateGovernanceNamespacesRequest {
/**
* tse 实例id。
*/
InstanceId: string;
/**
* 命名空间信息。
*/
GovernanceNamespaces: Array;
}
/**
* ModifyCloudNativeAPIGatewayRoute请求参数结构体
*/
export interface ModifyCloudNativeAPIGatewayRouteRequest {
/**
* 网关ID
*/
GatewayId: string;
/**
* 所属服务的ID
*/
ServiceID: string;
/**
* 路由的ID,实例级别唯一
*/
RouteID: string;
/**
* 路由的名字,实例级别唯一,可以不提供
*/
RouteName?: string;
/**
* 路由的方法,其中方法可选值:
- GET
- POST
- DELETE
- PUT
- OPTIONS
- PATCH
- HEAD
- ANY
- TRACE
- COPY
- MOVE
- PROPFIND
- PROPPATCH
- MKCOL
- LOCK
- UNLOCK
*/
Methods?: Array;
/**
* 路由的域名
*/
Hosts?: Array;
/**
* 路由的路径
*/
Paths?: Array;
/**
* 路由的协议,可选
*/
Protocols?: Array;
/**
* 转发到后端时是否保留Host
*/
PreserveHost?: boolean;
/**
* https重定向状态码
*/
HttpsRedirectStatusCode?: number;
/**
* 转发到后端时是否StripPath
*/
StripPath?: boolean;
/**
* 是否开启强制HTTPS
* @deprecated
*/
ForceHttps?: boolean;
/**
* 四层匹配的目的端口
*/
DestinationPorts?: Array;
/**
* 路由的Headers
*/
Headers?: Array;
/**
* 是否缓存请求body,默认true
*/
RequestBuffering?: boolean;
/**
* 是否缓存响应body,默认true
*/
ResponseBuffering?: boolean;
/**
* 增加优先级
*/
RegexPriority?: number;
/**
* querysring参数
*/
QueryStringParameters?: Array;
}
/**
* DeleteCloudNativeAPIGatewayIPRestriction请求参数结构体
*/
export interface DeleteCloudNativeAPIGatewayIPRestrictionRequest {
/**
* 网关ID
*/
GatewayId: string;
/**
* 访问控制插件绑定的资源类型:route|service
*/
SourceType: string;
/**
* 路由或服务的id
*/
SourceId: string;
}
/**
* 消费者结构
*/
export interface CNAPIGwConsumer {
/**
* 消费者 ID。
*/
ConsumerId: string;
/**
* 名字
*/
Name: string;
/**
* 创建时间
*/
CreateTime: string;
/**
* 更新时间 yyyy-MM-dd hh:mm:ss
*/
ModifyTime: string;
/**
* 消费者优先级
枚举值:
- Low: 低优先级
- Medium: 中优先级
- High: 高优先级
*/
Priority?: string;
/**
* 描述
注意:此字段可能返回 null,表示取不到有效值。
*/
Description?: string;
/**
* 消费者分组
注意:此字段可能返回 null,表示取不到有效值。
*/
ConsumerGroups?: Array;
/**
* 同步状态
枚举值:
*/
SyncStatus?: string;
/**
* 资源类型
枚举值:
- Public: 公共
- Private: 私有
- SourceDeleted: 已删除
*/
SourceType?: string;
/**
* 同步版本
*/
SyncedVersion?: string;
}
/**
* CreateGovernanceAlias返回参数结构体
*/
export interface CreateGovernanceAliasResponse {
/**
* 创建是否成功。
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 云原生API网关节点配置。
*/
export interface CloudNativeAPIGatewayNodeConfig {
/**
* 节点配置, 1c2g|2c4g|4c8g|8c16g。
*/
Specification: string;
/**
* 节点数量,2-9。
*/
Number: number;
}
/**
* DeleteConfigFileGroup返回参数结构体
*/
export interface DeleteConfigFileGroupResponse {
/**
* 是否删除成功
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* kong服务路由列表
*/
export interface KongServiceRouteList {
/**
* 无
*/
RouteList?: Array;
/**
* 总数
*/
TotalCount?: number;
}
/**
* 发布详情
*/
export interface ConfigFilePublishInfo {
/**
* 发布名称
*/
ReleaseName?: string;
/**
* 命名空间
*/
Namespace?: string;
/**
* 发布组
*/
Group?: string;
/**
* 文件名
*/
FileName?: string;
/**
* 内容
*/
Content?: string;
/**
* 描述
*/
Comment?: string;
/**
* 格式
*/
Format?: string;
/**
* 创建者
*/
CreateBy?: string;
/**
* 修改者
*/
ModifyBy?: string;
/**
* 标签
*/
Tags?: Array;
}
/**
* DeleteCloudNativeAPIGatewayConsumerGroup请求参数结构体
*/
export interface DeleteCloudNativeAPIGatewayConsumerGroupRequest {
/**
* 网关实例id
*/
GatewayId: string;
/**
* 消费者组ID
*/
ConsumerGroupId: string;
}
/**
* DescribeCloudNativeAPIGatewayLLMModelService请求参数结构体
*/
export interface DescribeCloudNativeAPIGatewayLLMModelServiceRequest {
/**
* 网关 id。
*/
GatewayId: string;
/**
* 模型服务 ID,全局唯一标识。
*/
ModelServiceId: string;
}
/**
* DescribeGovernanceAliases请求参数结构体
*/
export interface DescribeGovernanceAliasesRequest {
/**
* tse实例id。
*/
InstanceId: string;
/**
* 服务别名所指向的服务名。
*/
Service?: string;
/**
* 服务别名所指向的命名空间名。
*/
Namespace?: string;
/**
* 服务别名。
*/
Alias?: string;
/**
* 服务别名命名空间。
*/
AliasNamespace?: string;
/**
* 服务别名描述。
*/
Comment?: string;
/**
* 偏移量,默认为0。
*/
Offset?: number;
/**
* 返回数量,默认为20,最大值为100。
*/
Limit?: number;
}
/**
* ModifyCloudNativeAPIGatewayService返回参数结构体
*/
export interface ModifyCloudNativeAPIGatewayServiceResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* nacos服务端接口列表,用于云监控
*/
export interface NacosServerInterface {
/**
* 接口名
*/
Interface?: string;
}
/**
* DescribeInstanceTagInfos请求参数结构体
*/
export interface DescribeInstanceTagInfosRequest {
/**
* 实例ID
*/
InstanceId: string;
}
/**
* 治理中心命名空间输入参数
*/
export interface GovernanceNamespaceInput {
/**
* 命名空间名。
*/
Name: string;
/**
* 描述信息。
*/
Comment?: string;
/**
* 新增的可以操作此命名空间的用户ID列表
*/
UserIds?: Array;
/**
* 新增的可以操作此命名空间的用户组ID列表
*/
GroupIds?: Array;
/**
* 移除可以操作此命名空间的用户ID列表
*/
RemoveUserIds?: Array;
/**
* 移除可以操作此命名空间的用户组ID列表
*/
RemoveGroupIds?: Array;
/**
* 该命名空间下的服务对哪些命名空间下可见,
1、为空或者不填写,表示仅当前命名空间可见
2、列表内容仅一个元素,且为字符 *,表示所有命名空间可见(包括新增)
3、列表内容为部份命名空间名称,则只对这些命名空间下可见
*/
ServiceExportTo?: Array;
/**
* 是否开启同步到全局注册中心
*/
SyncToGlobalRegistry?: boolean;
}
/**
* DeleteGovernanceServices返回参数结构体
*/
export interface DeleteGovernanceServicesResponse {
/**
* 删除服务结果。
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteCloudNativeAPIGatewaySecretKey请求参数结构体
*/
export interface DeleteCloudNativeAPIGatewaySecretKeyRequest {
/**
* 网关ID
*/
GatewayId: string;
/**
* 密钥id
*/
SecretKeyId: string;
}
/**
* DeleteCloudNativeAPIGatewayCertificate返回参数结构体
*/
export interface DeleteCloudNativeAPIGatewayCertificateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteCloudNativeAPIGatewayCanaryRule请求参数结构体
*/
export interface DeleteCloudNativeAPIGatewayCanaryRuleRequest {
/**
* 网关 ID
*/
GatewayId: string;
/**
* 服务 ID
*/
ServiceId: string;
/**
* 优先级
*/
Priority?: number;
/**
* 优先级列表,如果配置了此参数,将以此参数为准,忽略Priority参数
*/
PriorityList?: Array;
}
/**
* 网关实例协议端口列表
*/
export interface GatewayInstanceSchemeAndPorts {
/**
* 端口协议,可选HTTP、HTTPS、TCP和UDP
*/
Scheme?: string;
/**
* 端口列表
*/
PortList?: Array;
}
/**
* 创建kong客户端公网结果
*/
export interface CreatePublicNetworkResult {
/**
* 网关实例ID
*/
GatewayId?: string;
/**
* 分组ID
*/
GroupId?: string;
/**
* 客户端公网网络ID
*/
NetworkId?: string;
}
/**
* CreateCloudNativeAPIGatewayLLMModelService请求参数结构体
*/
export interface CreateCloudNativeAPIGatewayLLMModelServiceRequest {
/**
* 网关 id。
*/
GatewayId: string;
/**
* 服务名称,最长60个字符,支持中英文大小写、数字及分隔符(“-”、“_”),不能以数字和分隔符开头,不能以分隔符结尾。
*/
Name: string;
/**
* 服务类型。目前仅支持 LLMService。
枚举值:
*/
ServiceType: string;
/**
* 选择模型提供商, 选项:OpenAI、Anthropic、Azure OpenAI等。
*/
ModelProvider: string;
/**
* API协议标准,根据供应商动态变化:OpenAI→OpenAI/v1,Anthropic→Anthropic/v1等
*/
ModelProtocol: string;
/**
* 模型选择方式,选项:Specify(指定模型)、PassThrough(透传请求模型)。
*/
ModelSelector: string;
/**
* LLM 厂商颁发的认证信息 token 。
*/
SecretKeyIds?: Array;
/**
* 默认模型,模型选择方式为 Specify 时必填。
*/
DefaultModel?: string;
/**
* 开启模型降级,模型选择方式为 Specify 时必填。
*/
EnableModelFallback?: boolean;
/**
* 可以配置备用模型规则,EnableSpecifyModelFallbackxa0为 true 时必填。
*/
ModelFallbackRule?: CloudNativeAPIGatewayLLMModelFallbackRule;
/**
* 开启模型参数校验,是否校验客户端传递的 model 参数,xa0模型选择方式为 PassThrough 时必填
*/
EnableModelParamCheck?: boolean;
/**
* 模型检验信息,EnableModelParamCheckxa0为 true 时必填。
*/
ModelParamCheckRule?: CloudNativeAPIGatewayLLMModelParamCheckInfo;
/**
* 描述。
*/
Description?: string;
/**
* 服务提供商自定义 url
*/
UpstreamURL?: string;
/**
* 连接超时时间
取值范围:[1, 3600000]
单位:毫秒
默认值:10000
*/
ConnectTimeout?: number;
/**
* 写入超时时间
取值范围:[1, 3600000]
单位:毫秒
默认值:60000
*/
WriteTimeout?: number;
/**
* 读取超时时间
取值范围:[1, 3600000]
单位:毫秒
默认值:60000
*/
ReadTimeout?: number;
/**
* 重试次数
取值范围:[0, 5]
单位:次
默认值:0
*/
Retries?: number;
/**
* 路径拼接模式
枚举值:
- FixedPath: 固定地址
- AutoConcat: 自动拼接
*/
UpstreamUrlMode?: string;
/**
* sni
*/
SNI?: string;
/**
* 模型服务级别的配额上限(RPM/TPM)。需要网关版本 ≥ 3.9.4。
*/
QuotaLimit?: AIGWLLMQuotaLimit;
/**
* 标签
*/
Tags?: Array;
/**
* 模型改写规则
*/
ModelRewriteRules?: Array;
/**
* 服务来源ID
*/
SourceId?: string;
/**
* 服务来源命名空间
*/
Namespace?: string;
/**
* 服务来源服务名
*/
ServiceName?: string;
/**
* 服务来源协议
*/
Protocol?: string;
/**
* 扩展参数
*/
ExtParams?: Array;
/**
* 自定义供应商名字
*/
CustomProviderName?: string;
/**
* 是否开启密钥轮转
*/
KeyRotationEnabled?: boolean;
/**
* 密钥轮转周期
单位:天数
*/
KeyRotationPeriodDays?: number;
/**
* 外部服务来源ID
*/
ExternalInstanceId?: string;
/**
* 负载均衡配置
*/
LoadBalanceConfig?: AIGWLoadBalanceConfig;
}
/**
* DescribeNativeGatewayServiceSources请求参数结构体
*/
export interface DescribeNativeGatewayServiceSourcesRequest {
/**
* 网关实例ID
*/
GatewayID: string;
/**
* 单页条数,最大100
*/
Limit: number;
/**
* 分页偏移量
*/
Offset: number;
/**
* 服务来源ID
*/
SourceID?: string;
/**
* 服务来源实例名称,模糊搜索
*/
SourceName?: string;
/**
* 微服务引擎类型:TSE-Nacos|TSE-Consul|TSE-PolarisMesh|Customer-Nacos|Customer-Consul|Customer-PolarisMesh
*/
SourceTypes?: Array;
/**
* 排序字段类型,当前仅支持SourceName
*/
OrderField?: string;
/**
* 排序类型,AES/DESC
*/
OrderType?: string;
}
/**
* CLB多可用区信息
*/
export interface CLBMultiRegion {
/**
* 是否启用多可用区
*/
CLBMultiZoneFlag?: boolean;
/**
* 主可用区信息
*/
CLBMasterZone?: string;
/**
* 备可用区信息
*/
CLBSlaveZone?: string;
}
/**
* CreateWafDomains返回参数结构体
*/
export interface CreateWafDomainsResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribePublicAddressConfig请求参数结构体
*/
export interface DescribePublicAddressConfigRequest {
/**
* 网关实例id
*/
GatewayId: string;
/**
* 查询该分组的公网信息,不传则查询实例所有的公网负载均衡信息
*/
GroupId?: string;
}
/**
* CreateConfigFileGroup请求参数结构体
*/
export interface CreateConfigFileGroupRequest {
/**
* tse 实例 id
*/
InstanceId: string;
/**
* 配置文件组实体
*/
ConfigFileGroup: ConfigFileGroup;
}
/**
* DescribeCloudNativeAPIGatewayUpstream返回参数结构体
*/
export interface DescribeCloudNativeAPIGatewayUpstreamResponse {
/**
* 无
*/
Result?: KongUpstreamList;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateOrModifyCloudNativeAPIGatewayIPRestriction返回参数结构体
*/
export interface CreateOrModifyCloudNativeAPIGatewayIPRestrictionResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 模型名字重写规则
*/
export interface AIGWModelRewriteRule {
/**
* 原始模型
*/
SourceModel?: string;
/**
* 目标模型
*/
TargetModel?: string;
}
/**
* 键值对
*/
export interface KVPair {
/**
* 键
*/
Key?: string;
/**
* 值
*/
Value?: string;
}
/**
* 消费者列表
*/
export interface CNAPIGwConsumerList {
/**
* 总数
*/
TotalCount?: number;
/**
* 消费者列表
注意:此字段可能返回 null,表示取不到有效值。
*/
Consumers?: Array;
}
/**
* UpdateUpstreamTargets请求参数结构体
*/
export interface UpdateUpstreamTargetsRequest {
/**
* 网关实例ID
*/
GatewayId: string;
/**
* 服务名称或ID
*/
Name: string;
/**
* 实例列表
*/
Targets?: Array;
}
/**
* DeleteCloudNativeAPIGatewayService返回参数结构体
*/
export interface DeleteCloudNativeAPIGatewayServiceResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeConfigFile请求参数结构体
*/
export interface DescribeConfigFileRequest {
/**
* TSE实例id
*/
InstanceId: string;
/**
* 命名空间
*/
Namespace?: string;
/**
* 组
*/
Group?: string;
/**
* 配置文件名称
*/
Name?: string;
/**
* 配置文件Id
*/
Id?: string;
}
/**
* 实例监听端口信息
*/
export interface InstancePort {
/**
* 监听的 http 端口范围。
*/
HttpPort?: string;
/**
* 监听的 https 端口范围。
*/
HttpsPort?: string;
/**
* 监听的 tcp 端口范围。
*/
TcpPort?: string;
/**
* 监听的 udp 端口范围。
*/
UdpPort?: string;
}
/**
* ModifyCloudNativeAPIGatewayConsumer请求参数结构体
*/
export interface ModifyCloudNativeAPIGatewayConsumerRequest {
/**
* 网关实例id
*/
GatewayId: string;
/**
* 消费者 ID。
*/
ConsumerId: string;
/**
* 消费者名称,最长 60 字符。
*/
Name: string;
/**
* 优先级,默认Medium
枚举值:
- Low: 低优先级
- Medium: 中优先级
- High: 高优先级
*/
Priority?: string;
/**
* 消费者描述。最长 200 字符。
*/
Description?: string;
}
/**
* DeleteNativeGatewayServerGroup请求参数结构体
*/
export interface DeleteNativeGatewayServerGroupRequest {
/**
* 网关实例id。
只支持后付费实例
*/
GatewayId: string;
/**
* 网关分组id
*/
GroupId: string;
}
/**
* DescribeCloudNativeAPIGatewayConsumerGroupList请求参数结构体
*/
export interface DescribeCloudNativeAPIGatewayConsumerGroupListRequest {
/**
* 网关实例id
*/
GatewayId: string;
/**
* 每页条数,范围 [1, 100],默认 10。
*/
Limit: number;
/**
* 起始位置,从 0 开始。
*/
Offset: number;
}
/**
* RollbackConfigFileReleases返回参数结构体
*/
export interface RollbackConfigFileReleasesResponse {
/**
* 回滚结果
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 配置文件发布历史
*/
export interface ConfigFileReleaseHistory {
/**
* 配置文件发布历史记录id
*/
Id?: number;
/**
* 配置文件发布历史名称
*/
Name?: string;
/**
* 配置文件发布历史命名空间
*/
Namespace?: string;
/**
* 配置文件发布历史组
*/
Group?: string;
/**
* 配置文件发布历史名称
*/
FileName?: string;
/**
* 配置文件发布历史内容
*/
Content?: string;
/**
* 配置文件发布历史格式
*/
Format?: string;
/**
* 配置文件发布历史注释
*/
Comment?: string;
/**
* 配置文件发布历史Md5
*/
Md5?: string;
/**
* 配置文件发布历史类型
*/
Type?: string;
/**
* 配置文件发布历史状态
*/
Status?: string;
/**
* 配置文件发布历史标签组
*/
Tags?: Array;
/**
* 配置文件发布创建时间
*/
CreateTime?: string;
/**
* 配置文件发布创建者
*/
CreateBy?: string;
/**
* 配置文件发布修改时间
*/
ModifyTime?: string;
/**
* 配置文件发布修改者
*/
ModifyBy?: string;
/**
* 发布描述
*/
ReleaseDescription?: string;
/**
* 原因,用于失败时原因展示
*/
ReleaseReason?: string;
/**
* 配置文件类型
*/
ConfigFileSupportedClient?: number;
/**
* 配置文件持久化
*/
ConfigFilePersistent?: ConfigFilePersistent;
}
/**
* 删除网关实例结果
*/
export interface DeleteNativeGatewayServerGroupResult {
/**
* 网关实例id
*/
GatewayId?: string;
/**
* 网关分组id
*/
GroupId?: string;
/**
* 删除状态
*/
Status?: string;
/**
* 任务ID
*/
TaskId?: string;
}
/**
* 服务治理相关的信息
*/
export interface ServiceGovernanceInfo {
/**
* 引擎所在的地域
*/
EngineRegion: string;
/**
* 服务治理引擎绑定的kubernetes集群信息
*/
BoundK8SInfos?: Array;
/**
* 服务治理引擎绑定的网络信息
*/
VpcInfos?: Array;
/**
* 当前实例鉴权是否开启
*/
AuthOpen?: boolean;
/**
* 该实例支持的功能,鉴权就是 Auth
*/
Features?: Array;
/**
* 主账户名默认为 polaris,该值为主账户的默认密码
*/
MainPassword?: string;
/**
* 服务治理pushgateway引擎绑定的网络信息
*/
PgwVpcInfos?: Array;
/**
* 服务治理限流server引擎绑定的网络信息
*/
LimiterVpcInfos?: Array;
/**
* 引擎关联CLS日志主题信息
*/
CLSTopics?: Array;
/**
* 子用户密码
*/
SubPassword?: string;
}
/**
* DescribeNacosReplicas返回参数结构体
*/
export interface DescribeNacosReplicasResponse {
/**
* 引擎实例副本信息
*/
Replicas?: Array;
/**
* 副本个数
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* Kong网关被动健康检查配置
*/
export interface KongPassiveHealthCheck {
/**
* 后端target协议类型,被动健康检查支持http和tcp,主动健康检查支持http
*/
Type?: string;
}
/**
* 灰度规则 Priority - Rule
*/
export interface CanaryPriorityRule {
/**
* 优先级
*/
Priority?: number;
/**
* 灰度规则配置
*/
CanaryRule?: CloudNativeAPIGatewayCanaryRule;
}
/**
* AI网关模型可用范围
*/
export interface AIGWModelScope {
/**
* 范围类型
枚举值:
- ALL: 允许全部访问
- ALLOWLIST: 允许访问的模型列表
- MAG: 模型访问组
*/
ScopeType?: string;
/**
* 允许访问的模型列表,ScopeType=ALLOWLIST时设置
*/
AllowList?: Array;
/**
* 模型访问组,ScopeType=MAG时设置
*/
MagRefs?: Array;
}
/**
* 私有网络信息
*/
export interface VpcInfo {
/**
* Vpc Id
*/
VpcId: string;
/**
* 子网ID
*/
SubnetId: string;
/**
* 内网访问地址
*/
IntranetAddress?: string;
/**
* 负载均衡均衡接入点子网ID
*/
LbSubnetId?: string;
}
/**
* 云原生API网关vpc配置。
*/
export interface CloudNativeAPIGatewayVpcConfig {
/**
* 私有网络ID。
*/
VpcId?: string;
/**
* 子网ID。
*/
SubnetId?: string;
}
/**
* DescribeGovernanceInstances返回参数结构体
*/
export interface DescribeGovernanceInstancesResponse {
/**
* 服务实例总数量。
*/
TotalCount?: number;
/**
* 服务里实例列表。
*/
Content?: Array;
/**
* 地域
*/
Location?: Location;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* LLM 模型 API 列表
*/
export interface ListCloudNativeAPIGatewayLLMModelAPI {
/**
* 总数
*/
TotalCount?: number;
/**
* AI 网关模型 API 列表。
*/
DataList?: Array;
}
/**
* ModifyGovernanceNamespaces返回参数结构体
*/
export interface ModifyGovernanceNamespacesResponse {
/**
* 操作是否成功。
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateConfigFile返回参数结构体
*/
export interface CreateConfigFileResponse {
/**
* 是否创建成功
*/
Result?: boolean;
/**
* 创建的配置文件Id
*/
ConfigFileId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCloudNativeAPIGateways请求参数结构体
*/
export interface DescribeCloudNativeAPIGatewaysRequest {
/**
* 返回数量,默认为 20,最大值为 100。
*/
Limit?: number;
/**
* 偏移量,默认为 0。
*/
Offset?: number;
/**
* 请求过滤参数,支持按照实例名称、ID和标签键值(Name、GatewayId、Tag)筛选
*/
Filters?: Array;
}
/**
* DescribeCloudNativeAPIGatewaySecretKeyList请求参数结构体
*/
export interface DescribeCloudNativeAPIGatewaySecretKeyListRequest {
/**
* 实例 ID
*/
GatewayId: string;
/**
* 每页条数,范围 [1, 100],默认 10。
*/
Limit: number;
/**
* 起始位置,从 0 开始。
*/
Offset: number;
/**
* 密钥归属资源类型。UseToBind=true 时必填。
枚举值:
- Consumer:消费者
- ModelService:模型服务
*/
ResourceType?: string;
}
/**
* 获取云原生API网关实例网络配置结果。
*/
export interface DescribeCloudNativeAPIGatewayConfigResult {
/**
* 网关实例ID。
*/
GatewayId?: string;
/**
* 分组网络配置列表。
*/
ConfigList?: Array;
/**
* 分组子网信息
*/
GroupSubnetId?: string;
/**
* 分组VPC信息
*/
GroupVpcId?: string;
/**
* 分组ID
*/
GroupId?: string;
}
/**
* 泳道规则
*/
export interface GovernanceLaneRule {
/**
* 泳道规则ID
注意:此字段可能返回 null,表示取不到有效值。
*/
ID?: string;
/**
* 泳道名称
注意:此字段可能返回 null,表示取不到有效值。
*/
Name?: string;
/**
* 泳道所属泳道组
注意:此字段可能返回 null,表示取不到有效值。
*/
LaneGroup?: string;
/**
* 泳道规则启用状态
注意:此字段可能返回 null,表示取不到有效值。
*/
Enable?: boolean;
/**
* 流量标签
注意:此字段可能返回 null,表示取不到有效值。
*/
TrafficLabels?: Array;
/**
* 多个流量标签匹配方式
AND:与
OR:或
注意:此字段可能返回 null,表示取不到有效值。
*/
TrafficMatchMode?: string;
/**
* 泳道匹配方式
STRICT:严格匹配
PERMISSIVE:宽松匹配
注意:此字段可能返回 null,表示取不到有效值。
*/
LaneMatchMode?: string;
/**
* 泳道灰度规则
*/
TrafficGray?: TrafficGray;
/**
* 泳道规则描述
注意:此字段可能返回 null,表示取不到有效值。
*/
Description?: string;
/**
* 泳道标签内容
注意:此字段可能返回 null,表示取不到有效值。
*/
LaneLabelValue?: string;
/**
* 创建时间
注意:此字段可能返回 null,表示取不到有效值。
*/
CreateTime?: string;
/**
* 启用时间
注意:此字段可能返回 null,表示取不到有效值。
*/
EnableTime?: string;
/**
* 修改时间
注意:此字段可能返回 null,表示取不到有效值。
*/
ModifyTime?: string;
/**
* 泳道规则优先级
注意:此字段可能返回 null,表示取不到有效值。
*/
Priority?: number;
/**
* 规则摘要
注意:此字段可能返回 null,表示取不到有效值。
*/
Revision?: string;
}
/**
* DeleteCloudNativeAPIGatewayService请求参数结构体
*/
export interface DeleteCloudNativeAPIGatewayServiceRequest {
/**
* 网关ID
*/
GatewayId: string;
/**
* 服务名字,服务ID
*/
Name: string;
/**
* 是否同步删除服务上绑定的路由
*/
DeleteRoutes?: boolean;
}
/**
* AI网关 Bearer Token 凭证配置
*/
export interface AIGWBearerTokenCredentialConfig {
/**
* Token凭证
*/
Token?: string;
}
/**
* 路由规则来源服务的请求规则配置详情
*/
export interface Argument {
/**
* 类型
注意:此字段可能返回 null,表示取不到有效值。
*/
Type?: string;
/**
* key值
注意:此字段可能返回 null,表示取不到有效值。
*/
Key?: string;
/**
* 匹配条件参数
注意:此字段可能返回 null,表示取不到有效值。
*/
Value?: ArgumentValue;
}
/**
* 查询云原生网关访问控制配置出参
*/
export interface DescribeKongIpRestrictionResult {
/**
* 访问控制插件绑定的资源类型:route | service
注意:此字段可能返回 null,表示取不到有效值。
*/
SourceType?: string;
/**
* 路由或服务的id
注意:此字段可能返回 null,表示取不到有效值。
*/
SourceId?: string;
/**
* 是否启用插件
注意:此字段可能返回 null,表示取不到有效值。
*/
Enabled?: boolean;
/**
* 访问控制类型:whiteList|blackList
注意:此字段可能返回 null,表示取不到有效值。
*/
RestrictionType?: string;
/**
* cidr|ip
注意:此字段可能返回 null,表示取不到有效值。
*/
AddressList?: Array;
}
/**
* 微服务网关选择器
*/
export interface ServiceGatewaySelector {
/**
* 命名空间
注意:此字段可能返回 null,表示取不到有效值。
*/
Namespace: string;
/**
* 服务
注意:此字段可能返回 null,表示取不到有效值。
*/
Service: string;
/**
* 实例标签
注意:此字段可能返回 null,表示取不到有效值。
*/
Labels?: Array