tencentcloud-sdk-nodejs
Version:
2,860 lines (2,857 loc) • 273 kB
TypeScript
/**
* 灰度命中规则
*/
export interface BetaLabel {
/**
* <p>键</p>
*/
Key?: string;
/**
* <p>值</p>
*/
Value?: BetaLabelMatchString;
}
/**
* DescribeNacosReplicas请求参数结构体
*/
export interface DescribeNacosReplicasRequest {
/**
* 引擎实例ID
*/
InstanceId: string;
/**
* 副本列表Limit
*/
Limit?: number;
/**
* 副本列表Offset
*/
Offset?: number;
}
/**
* DeleteWafDomains请求参数结构体
*/
export interface DeleteWafDomainsRequest {
/**
* 网关ID
*/
GatewayId: string;
/**
* WAF 防护域名列表
*/
Domains: Array<string>;
}
/**
* 列表过滤条件,模糊匹配
*/
export interface ListFilter {
/**
* 过滤字段
*/
Key?: string;
/**
* 过滤值
*/
Value?: string;
}
/**
* DescribeCloudNativeAPIGatewayNodes请求参数结构体
*/
export interface DescribeCloudNativeAPIGatewayNodesRequest {
/**
* 云原生API网关实例ID。
*/
GatewayId: string;
/**
* 实例分组id
*/
GroupId?: string;
/**
* 翻页获取多少个
*/
Limit?: number;
/**
* 翻页从第几个开始获取
*/
Offset?: number;
}
/**
* 服务别名结构信息
*/
export interface GovernanceAlias {
/**
* 服务别名
*/
Alias?: string;
/**
* 服务别名命名空间
*/
AliasNamespace?: string;
/**
* 服务别名指向的服务名
*/
Service?: string;
/**
* 服务别名指向的服务命名空间
*/
Namespace?: string;
/**
* 服务别名的描述信息
*/
Comment?: string;
/**
* 服务别名创建时间
*/
CreateTime?: string;
/**
* 服务别名修改时间
*/
ModifyTime?: string;
/**
* 服务别名ID
*/
Id?: string;
/**
* 该服务别名是否可以编辑
*/
Editable?: boolean;
/**
* 元数据信息
*/
Metadatas?: Array<Metadata>;
}
/**
* DescribeCloudNativeAPIGatewayUpstream请求参数结构体
*/
export interface DescribeCloudNativeAPIGatewayUpstreamRequest {
/**
* 网关ID
*/
GatewayId: string;
/**
* 服务名字
*/
ServiceName: string;
}
/**
* AI 网关意图路由配置
*/
export interface AIGWIntentRoute {
/**
* <p>意图识别模型id</p>
*/
IntentModelServiceId: string;
/**
* <p>置信度</p>
*/
ConfidenceThreshold: number;
/**
* <p>默认服务id</p>
*/
DefaultModelServiceId: string;
/**
* <p>规则</p>
*/
Rules?: Array<AIGWIntentRouteRule>;
}
/**
* 元数据信息
*/
export interface Metadata {
/**
* 元数据键名。
*/
Key: string;
/**
* 元数据键值。不填则默认为空字符串。
*/
Value?: string;
}
/**
* RemoveCloudNativeAPIGatewayConsumerGroupAuth返回参数结构体
*/
export interface RemoveCloudNativeAPIGatewayConsumerGroupAuthResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeUpstreamHealthCheckConfig请求参数结构体
*/
export interface DescribeUpstreamHealthCheckConfigRequest {
/**
* 网关ID
*/
GatewayId: string;
/**
* 网关服务名称
*/
Name: string;
}
/**
* Key/Value结构
*/
export interface KeyValue {
/**
* 条件的Key
*/
Key?: string;
/**
* 条件的Value
*/
Value?: string;
}
/**
* CreateNativeGatewayServerGroup请求参数结构体
*/
export interface CreateNativeGatewayServerGroupRequest {
/**
* 网关实例id。
只支持后付费实例
*/
GatewayId: string;
/**
* 网关分组名
*/
Name: string;
/**
* 节点配置
*/
NodeConfig: CloudNativeAPIGatewayNodeConfig;
/**
* 子网id
*/
SubnetId: string;
/**
* 描述信息
*/
Description?: string;
/**
* 公网带宽信息
*/
InternetMaxBandwidthOut?: number;
/**
* 公网配置。
*/
InternetConfig?: InternetConfig;
}
/**
* DescribeCloudNativeAPIGatewayCertificates请求参数结构体
*/
export interface DescribeCloudNativeAPIGatewayCertificatesRequest {
/**
* 网关ID
*/
GatewayId: string;
/**
* 列表数量
*/
Limit?: number;
/**
* 列表offset
*/
Offset?: number;
/**
* 过滤条件,多个过滤条件之间是与的关系,支持BindDomain ,Name
*/
Filters?: Array<ListFilter>;
}
/**
* DeleteGovernanceLaneGroups返回参数结构体
*/
export interface DeleteGovernanceLaneGroupsResponse {
/**
* 是否创建成功
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 删除云原生API网关响应结果。
*/
export interface DeleteCloudNativeAPIGatewayResult {
/**
* 云原生网关ID。
*/
GatewayId: string;
/**
* 云原生网关状态。
*/
Status: string;
}
/**
* CloseWafProtection请求参数结构体
*/
export interface CloseWafProtectionRequest {
/**
* 网关ID
*/
GatewayId: string;
/**
* 防护资源的类型。
- Global 实例
- Service 服务
- Route 路由
- Object 对象
*/
Type: string;
/**
* 当资源类型 Type 是 Service 或 Route 的时候,传入的服务或路由的列表
*/
List?: Array<string>;
}
/**
* 泳道组
*/
export interface DeleteGovernanceLaneGroup {
/**
* 泳道名称
注意:此字段可能返回 null,表示取不到有效值。
*/
Name: string;
/**
* 泳道组ID
注意:此字段可能返回 null,表示取不到有效值。
*/
ID?: string;
/**
* 泳道入口服务列表
注意:此字段可能返回 null,表示取不到有效值。
*/
TrafficEntries?: Array<LaneTrafficEntry>;
/**
* 泳道服务列表
注意:此字段可能返回 null,表示取不到有效值。
*/
Destinations?: Array<GovernanceServiceDestination>;
/**
* 泳道组描述
注意:此字段可能返回 null,表示取不到有效值。
*/
Description?: string;
/**
* 规则内容摘要
注意:此字段可能返回 null,表示取不到有效值。
*/
Revision?: string;
/**
* 创建时间
注意:此字段可能返回 null,表示取不到有效值。
*/
CreateTime?: string;
/**
* 修改时间
注意:此字段可能返回 null,表示取不到有效值。
*/
ModifyTime?: string;
/**
* 规则一致性状态
注意:此字段可能返回 null,表示取不到有效值。
*/
Consistency?: string;
/**
* 泳道规则列表
注意:此字段可能返回 null,表示取不到有效值。
*/
Rules?: Array<GovernanceLaneRule>;
}
/**
* DescribeCloudNativeAPIGatewayNodes返回参数结构体
*/
export interface DescribeCloudNativeAPIGatewayNodesResponse {
/**
* 获取云原生网关节点列表结果。
*/
Result: DescribeCloudNativeAPIGatewayNodesResult;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateCloudNativeAPIGateway返回参数结构体
*/
export interface CreateCloudNativeAPIGatewayResponse {
/**
* 创建云原生API网关实例响应结果。
*/
Result?: CreateCloudNativeAPIGatewayResult;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyCloudNativeAPIGatewayLLMModelService请求参数结构体
*/
export interface ModifyCloudNativeAPIGatewayLLMModelServiceRequest {
/**
* <p>网关 id。</p>
*/
GatewayId: string;
/**
* <p>模型服务 ID,全局唯一标识。</p>
*/
ModelServiceId: string;
/**
* <p>修改服务名称,长度2-50字符,支持中英文、数字、下划线。</p>
*/
Name?: string;
/**
* <p>修改默认模型,模型选择方式为 Specify 时必填。</p>
*/
DefaultModel?: string;
/**
* <p>修改模型选择方式,选项:Specify(指定模型)、PassThrough(透传请求模型)。</p>
*/
ModelSelector?: string;
/**
* <p>修改开启模型降级,模型选择方式为 Specify 时必填。</p>
*/
EnableModelFallback?: boolean;
/**
* <p>修改可以配置备用模型规则,EnableSpecifyModelFallback 为 true 时必填。</p>
*/
ModelFallbackRule?: CloudNativeAPIGatewayLLMModelFallbackRule;
/**
* <p>修改开启模型参数校验,是否校验客户端传递的 model 参数, 模型选择方式为 PassThrough 时必填</p>
*/
EnableModelParamCheck?: boolean;
/**
* <p>修改模型检验信息,EnableModelParamCheck 为 true 时必填。</p>
*/
ModelParamCheckRule?: CloudNativeAPIGatewayLLMModelParamCheckInfo;
/**
* <p>修改描述。</p>
*/
Description?: string;
/**
* <p>修改模型服务地址</p>
*/
UpstreamURL?: string;
/**
* <p>连接超时时间</p><p>取值范围:[1, 3600000]</p><p>单位:毫秒</p><p>默认值:10000</p>
*/
ConnectTimeout?: number;
/**
* <p>写入超时时间</p><p>取值范围:[1, 3600000]</p><p>单位:毫秒</p><p>默认值:60000</p>
*/
WriteTimeout?: number;
/**
* <p>读取超时时间</p><p>取值范围:[1, 3600000]</p><p>单位:毫秒</p><p>默认值:60000</p>
*/
ReadTimeout?: number;
/**
* <p>重试次数</p><p>取值范围:[0, 5]</p><p>单位:次</p><p>默认值:0</p>
*/
Retries?: number;
/**
* <p>路径拼接模式</p><p>枚举值:</p><ul><li>FixedPath: 固定路径</li><li>AutoConcat: 自动拼接</li></ul>
*/
UpstreamUrlMode?: string;
/**
* <p>SNI</p>
*/
SNI?: string;
/**
* <p>模型服务级别的配额上限(RPM/TPM)。需要网关版本 ≥ 3.9.4。</p>
*/
QuotaLimit?: AIGWLLMQuotaLimit;
/**
* <p>标签</p>
*/
Tags?: Array<string>;
/**
* <p>模型改写规则</p>
*/
ModelRewriteRules?: Array<AIGWModelRewriteRule>;
/**
* <p>来源 id</p>
*/
SourceId?: string;
/**
* <p>命名空间</p>
*/
Namespace?: string;
/**
* <p>服务名字</p>
*/
ServiceName?: string;
/**
* <p>协议</p>
*/
Protocol?: string;
/**
* <p>扩展参数</p>
*/
ExtParams?: Array<KeyValue>;
/**
* <p>密钥轮转开关</p>
*/
KeyRotationEnabled?: boolean;
/**
* <p>密钥轮转天数</p>
*/
KeyRotationPeriodDays?: number;
/**
* <p>外部服务来源ID</p>
*/
ExternalInstanceId?: string;
}
/**
* 分组列表
*/
export interface CNAPIGwConsumerGroupList {
/**
* 总数
*/
TotalCount?: number;
/**
* 消费者分组信息
*/
ConsumerGroups?: Array<CNAPIGwConsumerGroup>;
}
/**
* 网络访问策略
*/
export interface NetworkAccessControl {
/**
* 访问模式:Whitelist|Blacklist
*/
Mode: string;
/**
* 白名单列表
*/
CidrWhiteList?: Array<string>;
/**
* 黑名单列表
*/
CidrBlackList?: Array<string>;
}
/**
* 查询客户端公网信息
*/
export interface DescribePublicNetworkResult {
/**
* 网关实例ID
*/
GatewayId?: string;
/**
* 网关分组ID
*/
GroupId?: string;
/**
* 客户端公网信息
*/
PublicNetwork?: CloudNativeAPIGatewayConfig;
}
/**
* DescribeGovernanceLaneGroups返回参数结构体
*/
export interface DescribeGovernanceLaneGroupsResponse {
/**
* 总数
*/
Total?: number;
/**
* 泳道规则列表
*/
LaneGroups?: Array<GovernanceLaneGroup>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 网关数据来源单个描述
*/
export interface NativeGatewayServiceSourceItem {
/**
* 网关实例ID
*/
GatewayID: string;
/**
* 服务来源ID
*/
SourceID: string;
/**
* 服务来源名称
*/
SourceName: string;
/**
* 服务来源类型
*/
SourceType: string;
/**
* 服务来源额外信息
*/
SourceInfo: SourceInfo;
/**
* 创建时间
*/
CreateTime: string;
/**
* 修改时间
*/
ModifyTime: string;
}
/**
* CreateNativeGatewayServiceSource返回参数结构体
*/
export interface CreateNativeGatewayServiceSourceResponse {
/**
* 创建是否成功
*/
Result?: boolean;
/**
* 服务来源ID
*/
SourceID?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateCloudNativeAPIGatewayService请求参数结构体
*/
export interface CreateCloudNativeAPIGatewayServiceRequest {
/**
* 网关ID
*/
GatewayId: string;
/**
* 服务名称
*/
Name: string;
/**
* 请求协议:
- https
- http
- tcp
- udp
*/
Protocol: string;
/**
* 超时时间,单位ms
*/
Timeout: number;
/**
* 重试次数
*/
Retries: number;
/**
* 服务类型:
- Kubernetes
- Registry
- IPList
- HostIP
- Scf
*/
UpstreamType: string;
/**
* 服务配置信息
*/
UpstreamInfo: KongUpstreamInfo;
/**
* 请求路径
*/
Path?: string;
}
/**
* AI网关 JWT 凭证物料配置
*/
export interface AIGWJWTCredentialConfig {
/**
* <p>JWT 消费者标识,iss claim</p>
*/
Key: string;
/**
* <p>签名算法,取值:HS256 HS384 HS512 RS256 RS384 RS512 ES256 ES384 ES512</p>
*/
Algorithm: string;
/**
* <p>HS 对称密钥,仅 Algorithm 为 HS256/HS384/HS512 时必填;RS/ES* 时留空</p>
*/
Secret?: string;
/**
* <p>RS/ES PEM 格式公钥,仅 Algorithm 为 RS256/RS384/RS512/ES256/ES384/ES512 时必填;HS* 时留空</p>
*/
RSAPublicKey?: string;
}
/**
* ModifyConsoleNetwork请求参数结构体
*/
export interface ModifyConsoleNetworkRequest {
/**
* 云原生API网关实例ID。
*/
GatewayId: string;
/**
* 网络类型:
- Open 公网
- Internal 内网(暂不支持)
*/
NetworkType: string;
/**
* 开启Konga网络,不填时默认为Open
- Open,开启
- Close,关闭
*/
Operate?: string;
/**
* 访问控制策略
*/
AccessControl?: NetworkAccessControl;
}
/**
* 公网地址信息
*/
export interface PublicAddressConfig {
/**
* 公网 ip
*/
Vip?: string;
/**
* 公网最大带宽
*/
InternetMaxBandwidthOut?: number;
/**
* 公网所属分组 id
*/
GroupId?: string;
/**
* 公网所属分组名
*/
GroupName?: string;
/**
* 公网负载均衡 id
*/
NetworkId?: string;
/**
* 公网负载均衡描述
*/
Description?: string;
}
/**
* 微服务注册引擎实例
*/
export interface SREInstance {
/**
* 实例ID
*/
InstanceId?: string;
/**
* 名称
*/
Name?: string;
/**
* 版本号
*/
Edition?: string;
/**
* 状态, 枚举值:creating/create_fail/running/updating/update_fail/restarting/restart_fail/destroying/destroy_fail
*/
Status?: string;
/**
* 规格ID
*/
SpecId?: string;
/**
* 副本数
*/
Replica?: number;
/**
* 类型
*/
Type?: string;
/**
* Vpc iD
*/
VpcId?: string;
/**
* 子网ID
*/
SubnetIds?: Array<string>;
/**
* 是否开启持久化存储
*/
EnableStorage?: boolean;
/**
* 数据存储方式
*/
StorageType?: string;
/**
* 云硬盘容量
*/
StorageCapacity?: number;
/**
* 计费方式
*/
Paymode?: string;
/**
* EKS集群的ID
*/
EKSClusterID?: string;
/**
* 集群创建时间
*/
CreateTime?: string;
/**
* 环境配置信息列表
*/
EnvInfos?: Array<EnvInfo>;
/**
* 引擎所在的区域
*/
EngineRegion?: string;
/**
* 注册引擎是否开启公网
*/
EnableInternet?: boolean;
/**
* 私有网络列表信息
*/
VpcInfos?: Array<VpcInfo>;
/**
* 服务治理相关信息列表
*/
ServiceGovernanceInfos?: Array<ServiceGovernanceInfo>;
/**
* 实例的标签信息
*/
Tags?: Array<KVPair>;
/**
* 引擎实例是否开启控制台公网访问地址
*/
EnableConsoleInternet?: boolean;
/**
* 引擎实例是否开启控制台内网访问地址
*/
EnableConsoleIntranet?: boolean;
/**
* 引擎实例是否展示参数配置页面
*/
ConfigInfoVisible?: boolean;
/**
* 引擎实例控制台默认密码
*/
ConsoleDefaultPwd?: string;
/**
* 交易付费类型,0后付费/1预付费
*/
TradeType?: number;
/**
* 自动续费标记:0表示默认状态(用户未设置,即初始状态), 1表示自动续费,2表示明确不自动续费
*/
AutoRenewFlag?: number;
/**
* 预付费到期时间
*/
CurDeadline?: string;
/**
* 隔离开始时间
*/
IsolateTime?: string;
/**
* 实例地域相关的描述信息
*/
RegionInfos?: Array<DescribeInstanceRegionInfo>;
/**
* 所在EKS环境,分为common和yunti
*/
EKSType?: string;
/**
* 引擎的产品版本
*/
FeatureVersion?: string;
/**
* 引擎实例是否开启客户端内网访问地址
*/
EnableClientIntranet?: boolean;
/**
* 存储额外配置选项
*/
StorageOption?: Array<StorageOption>;
/**
* Zookeeper的额外环境数据信息
*/
ZookeeperRegionInfo?: ZookeeperRegionInfo;
/**
* 部署架构
*/
DeployMode?: string;
/**
* 全局属性
*/
GlobalType?: string;
/**
* 所属组类型
*/
GroupType?: string;
/**
* 组id
*/
GroupId?: Array<string>;
/**
* 是否为主地域
*/
IsMainRegion?: boolean;
}
/**
* DescribeCloudNativeAPIGatewayServices请求参数结构体
*/
export interface DescribeCloudNativeAPIGatewayServicesRequest {
/**
* 网关ID
*/
GatewayId: string;
/**
* 列表数量
*/
Limit?: number;
/**
* 列表 offset
*/
Offset?: number;
/**
* 过滤条件,多个过滤条件之间是与的关系,支持 name,upstreamType
*/
Filters?: Array<ListFilter>;
}
/**
* CreateCloudNativeAPIGatewayLLMModelAPI请求参数结构体
*/
export interface CreateCloudNativeAPIGatewayLLMModelAPIRequest {
/**
* <p>网关 id。</p>
*/
GatewayId: string;
/**
* <p>模型 API 名称,最长 60 字符。同一网关下唯一。</p>
*/
Name: string;
/**
* <p>业务场景。</p><p>枚举值:</p><ul><li>Chat:聊天</li><li>Image:图像(需要网关版本 ≥ 3.9.3)</li></ul>
*/
SceneType: string;
/**
* <p>请求协议(小写)。当前仅支持:</p><ul><li>openai</li></ul>
*/
RequestProtocol: string;
/**
* <p>关联的模型服务 ID 列表,长度 1-10。</p><p>注:字段名建议改为 ModelServiceIds,当前保留用于兼容。</p>
*/
ListModelServiceId: Array<string>;
/**
* <p>路由列表,至少 1 条。每条包含 Methods/Paths/Hosts 等 Kong 路由属性。</p>
*/
RouteList: Array<DefaultKongRoute>;
/**
* <p>统一前缀路径(可选)。例如 /v1/openai。</p>
*/
BasePath?: string;
/**
* <p>模型 API 描述。最长 200 字符。</p>
*/
Description?: string;
/**
* <p>多模型服务路由策略。ListModelServiceId 多于 1 项时必填。</p>
*/
ModelServiceRoute?: CloudNativeAPIGatewayLLMModelServiceRoute;
/**
* <p>Header 路由匹配规则。当前仅支持 Operator=exact。</p>
*/
MatchHeaders?: Array<AIGWKVMatch>;
/**
* <p>是否启用跨服务 Fallback。开启后需提供 CrossServiceFallbackConfig。</p>
*/
EnableCrossServiceFallback?: boolean;
/**
* <p>跨服务 Fallback 配置。EnableCrossServiceFallback=true 时必填。</p>
*/
CrossServiceFallbackConfig?: AIGWCrossServiceFallbackConfig;
/**
* <p>标签过滤策略。需要网关版本 ≥ 3.9.4。</p>
*/
TagFilter?: AIGWTagFilter;
/**
* <p>日志输出配置(请求/响应 payload 落 LLM Log)。需要网关版本 ≥ 3.9.4。</p>
*/
LogConfig?: AIGWLogConfig;
}
/**
* 服务实例组
*/
export interface GovernanceServiceDestination {
/**
* 命名空间
注意:此字段可能返回 null,表示取不到有效值。
*/
Namespace: string;
/**
* 服务
注意:此字段可能返回 null,表示取不到有效值。
*/
Service: string;
/**
* 实例标签
注意:此字段可能返回 null,表示取不到有效值。
*/
Labels?: Array<RoutingDestinationRuleLabel>;
}
/**
* DescribeCloudNativeAPIGatewayConsumerList请求参数结构体
*/
export interface DescribeCloudNativeAPIGatewayConsumerListRequest {
/**
* <p>网关实例id</p>
*/
GatewayId: string;
/**
* <p>页显示条数,最大20</p>
*/
Limit: number;
/**
* <p>起始位置</p>
*/
Offset: number;
/**
* <p>资源类型</p><p>枚举值:</p><ul><li>ModelAPI: 模型API</li><li>MCPServer: MCP服务</li></ul>
*/
ResourceType?: string;
/**
* <p>资源ID</p>
*/
ResourceId?: string;
}
/**
* CreateCloudNativeAPIGatewayConsumer请求参数结构体
*/
export interface CreateCloudNativeAPIGatewayConsumerRequest {
/**
* 网关实例id
*/
GatewayId: string;
/**
* <p>消费者名称,最长 60 字符。同一网关下唯一。</p>
*/
Name: string;
/**
* <p>消费者描述。最长 200 字符。</p>
*/
Description?: string;
}
/**
* CreateCloudNativeAPIGatewayCanaryRule返回参数结构体
*/
export interface CreateCloudNativeAPIGatewayCanaryRuleResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* LLM 模型 API
*/
export interface CloudNativeAPIGatewayLLMModelAPI {
/**
* <p>模型 API ID。</p>
*/
Id?: string;
/**
* <p>创建时间</p>
*/
CreateTime?: string;
/**
* <p>修改时间</p>
*/
ModifyTime?: string;
/**
* <p>AI 网关 LLM 模型 API 的唯一标识名称,格式规则:2-50 字符,支持英文、数字、下划线。</p>
*/
Name?: string;
/**
* <p>选择业务场景,xa0 选项:Chat(聊天)。</p>
*/
SceneType?: string;
/**
* <p>业务场景对应的请求协议,选项:OpenAI(目前只支持 OpenAI)。</p>
*/
RequestProtocol?: string;
/**
* <p>路由列表</p>
*/
RouteList?: Array<DefaultKongRoute>;
/**
* <p>为API设置统一的前缀,格式:以/开头,支持字母、数字、短横线。</p>
*/
BasePath?: string;
/**
* <p>路径简化,<br>启用时:客户端请求路径 → 移除Base Path → 后端接收简洁路径<br>禁用时:客户端请求路径 → 完整传递给后端。</p>
*/
StripPath?: boolean;
/**
* <p>模型 API 的相关描述。</p>
*/
Description?: string;
/**
* <p>模型服务Id</p>
*/
ModelServiceId?: string;
/**
* <p>模型服务名称</p>
*/
ModelServiceName?: string;
/**
* <p>模型服务路由策略(是指如何路由到模型服务)</p>
*/
ModelServiceRoute?: CloudNativeAPIGatewayLLMModelServiceRoute;
/**
* <p>无</p>
*/
MatchHeaders?: Array<AIGWKVMatch>;
/**
* <p>是否开启跨服务fallback</p>
*/
EnableCrossServiceFallback?: boolean;
/**
* <p>跨服务fallback配置详情</p>
*/
CrossServiceFallbackConfig?: AIGWCrossServiceFallbackConfig;
/**
* <p>是否展示模型API</p>
*/
DescribeCloudNativeAPIGatewayLLMModelAPI?: boolean;
/**
* <p>标签</p>
*/
TagFilter?: AIGWTagFilter;
/**
* <p>日志显示相关开关</p>
*/
LogConfig?: AIGWLogConfig;
/**
* <p>日志脱敏规则</p>
*/
LogDesensitizeConfig?: AIGWLogDesensitizeConfig;
/**
* <p>转发脱敏规则</p>
*/
ForwardDesensitizeConfig?: AIGWForwardDesensitizeConfig;
}
/**
* DeleteGovernanceNamespaces返回参数结构体
*/
export interface DeleteGovernanceNamespacesResponse {
/**
* 删除是否成功。
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 标签
*/
export interface Label {
/**
* 标签键名称
*/
Key?: string;
/**
* 标签值
*/
Value?: string;
}
/**
* DescribeCloudNativeAPIGatewayRoutes返回参数结构体
*/
export interface DescribeCloudNativeAPIGatewayRoutesResponse {
/**
* 无
*/
Result?: KongServiceRouteList;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeWafProtection返回参数结构体
*/
export interface DescribeWafProtectionResponse {
/**
* 保护状态
*/
Result?: DescribeWafProtectionResult;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeZookeeperReplicas请求参数结构体
*/
export interface DescribeZookeeperReplicasRequest {
/**
* 注册引擎实例ID
*/
InstanceId: string;
/**
* 副本列表Limit
*/
Limit?: number;
/**
* 副本列表Offset
*/
Offset?: number;
}
/**
* DescribeAutoScalerResourceStrategies返回参数结构体
*/
export interface DescribeAutoScalerResourceStrategiesResponse {
/**
* 获取云原生API网关实例弹性伸缩策略列表响应结果。
*/
Result?: ListCloudNativeAPIGatewayStrategyResult;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 获取云原生API网关基础信息响应结果。
*/
export interface DescribeCloudNativeAPIGatewayResult {
/**
* <p>云原生API网关ID。</p>
*/
GatewayId?: string;
/**
* <p>云原生API网关状态。</p>
*/
Status?: string;
/**
* <p>云原生API网关名。</p>
*/
Name?: string;
/**
* <p>云原生API网关类型。</p>
*/
Type?: string;
/**
* <p>实例版本:</p><ul><li>2.4.1</li><li>2.5.1</li></ul>
*/
GatewayVersion?: string;
/**
* <p>云原生API网关节点信息。</p>
*/
NodeConfig?: CloudNativeAPIGatewayNodeConfig;
/**
* <p>云原生API网关vpc配置。</p>
*/
VpcConfig?: CloudNativeAPIGatewayVpcConfig;
/**
* <p>云原生API网关描述。</p>
*/
Description?: string;
/**
* <p>云原生API网关创建时间。</p>
*/
CreateTime?: string;
/**
* <p>实例的标签信息</p>
*/
Tags?: Array<InstanceTagInfo>;
/**
* <p>是否开启 cls 日志</p>
*/
EnableCls?: boolean;
/**
* <p>付费模式,0表示后付费,1预付费</p>
*/
TradeType?: number;
/**
* <p>实例版本,当前支持开发版、标准版、专业版【TRIAL、STANDARD、PROFESSIONAL】</p>
*/
FeatureVersion?: string;
/**
* <p>公网出流量带宽,[1,2048]Mbps</p>
*/
InternetMaxBandwidthOut?: number;
/**
* <p>自动续费标记,0表示默认状态(用户未设置,即初始状态);<br>1表示自动续费,2表示明确不自动续费(用户设置),若业务无续费概念或无需自动续费,需要设置为0</p>
*/
AutoRenewFlag?: number;
/**
* <p>到期时间,预付费时使用</p>
*/
CurDeadline?: string;
/**
* <p>隔离时间,实例隔离时使用</p>
*/
IsolateTime?: string;
/**
* <p>是否开启客户端公网。</p>
*/
EnableInternet?: boolean;
/**
* <p>实例实际的地域信息</p>
*/
EngineRegion?: string;
/**
* <p>Ingress class名称</p>
*/
IngressClassName?: string;
/**
* <p>公网计费方式。可选取值 BANDWIDTH | TRAFFIC ,表示按带宽和按流量计费。</p>
*/
InternetPayMode?: string;
/**
* <p>云原生API网关小版本号</p>
*/
GatewayMinorVersion?: string;
/**
* <p>实例监听的端口信息</p>
*/
InstancePort?: InstancePort;
/**
* <p>公网CLB默认类型</p>
*/
LoadBalancerType?: string;
/**
* <p>公网IP地址列表</p>
*/
PublicIpAddresses?: Array<string>;
/**
* <p>是否开启删除保护</p>
*/
DeleteProtect?: boolean;
/**
* <p>表示可以升级的版本号</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
AvailableVersions?: Array<string>;
/**
* <p>网关可以升级的版本号列表</p>
*/
AvailableUpgradeVersions?: Array<string>;
/**
* <p>是否提示可升级</p>
*/
AvailableUpgrade?: boolean;
/**
* <p>可回退的版本</p>
*/
AvailableRollbackVersion?: string;
/**
* <p>强制跳转HTTPS开关</p>
*/
ForceHTTPSRedirect?: boolean;
}
/**
* 北极星日志主题信息
*/
export interface PolarisCLSTopicInfo {
/**
* 日志集ID
*/
LogSetId?: string;
/**
* 日志集名称
*/
LogSetName?: string;
/**
* 日志主题ID
*/
TopicId?: string;
/**
* 日志主题名称
*/
TopicName?: string;
}
/**
* DeleteCloudNativeAPIGatewayRoute返回参数结构体
*/
export interface DeleteCloudNativeAPIGatewayRouteResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AI 网关 B 层日志脱敏配置(写入 LLM Log 前对 payload 掩码)
*/
export interface AIGWLogDesensitizeConfig {
/**
* <p>日志脱敏开关</p>
*/
Enabled: boolean;
/**
* <p>预定义规则类型</p><p>枚举值:</p><ul><li>Phone: 电话号码</li><li>IdCard: 身份证号</li><li>BankCard: 银行卡号</li><li>Email: 邮箱地址</li><li>IP: IP地址</li><li>Name: 姓名</li></ul>
*/
PredefinedRuleTypes?: Array<string>;
/**
* <p>自定义脱敏规则</p>
*/
CustomRules?: Array<AIGWCustomDesensitizeRule>;
/**
* <p>日志脱敏范围</p><p>枚举值:</p><ul><li>Request: 请求</li><li>Response: 响应</li></ul>
*/
Scope?: Array<string>;
}
/**
* DeleteCloudNativeAPIGatewayLLMModelService返回参数结构体
*/
export interface DeleteCloudNativeAPIGatewayLLMModelServiceResponse {
/**
* <p>是否成功。</p>
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteCloudNativeAPIGatewayServiceRateLimit请求参数结构体
*/
export interface DeleteCloudNativeAPIGatewayServiceRateLimitRequest {
/**
* 网关Id
*/
GatewayId: string;
/**
* 服务名称,或服务ID
*/
Name: string;
}
/**
* AI 网关意图路由规则
*/
export interface AIGWIntentRouteRule {
/**
* <p>意图编码</p><p>枚举值:</p><ul><li>Coder: 代码编写</li><li>Math: 数学计算</li><li>Translation: 翻译</li><li>Flash: 快速问答</li><li>Complex: 复杂推理</li></ul>
*/
IntentCode?: string;
/**
* <p>模型服务id</p>
*/
ModelServiceId?: string;
}
/**
* 灰度规则列表
*/
export interface CloudAPIGatewayCanaryRuleList {
/**
* 灰度规则
*/
CanaryRuleList?: Array<CloudNativeAPIGatewayCanaryRule>;
/**
* 总数
*/
TotalCount?: number;
}
/**
* ModifyUpstreamNodeStatus请求参数结构体
*/
export interface ModifyUpstreamNodeStatusRequest {
/**
* 网关实例ID
*/
GatewayId: string;
/**
* 服务名称
*/
ServiceName: string;
/**
* 访问IP地址或域名
*/
Host: string;
/**
* 访问端口
*/
Port: number;
/**
* HEALTHY或UNHEALTHY
*/
Status: string;
}
/**
* 云原生网关Tse 限流插件配置
*/
export interface CloudNativeAPIGatewayRateLimitDetail {
/**
* 插件启用状态
*/
Enabled?: boolean;
/**
* qps阈值
*/
QpsThresholds?: Array<QpsThreshold>;
/**
* 需要进行流量控制的请求路径
*/
Path?: string;
/**
* 需要进行流量控制的请求头Key
*/
Header?: string;
/**
* 限流依据
ip service consumer credential path header
*/
LimitBy?: string;
/**
* 外部redis配置
*/
ExternalRedis?: ExternalRedis;
/**
* 全局配置中的redis配置
*/
GlobalConfigId?: string;
/**
* 计数器策略
local 单机
redis 默认redis
external_redis 外部redis
*/
Policy?: string;
/**
* 响应配置,响应策略为text
*/
RateLimitResponse?: RateLimitResponse;
/**
* 请求转发地址
*/
RateLimitResponseUrl?: string;
/**
* 响应策略
url请求转发
text 响应配置
default 直接返回
*/
ResponseType?: string;
/**
* 是否隐藏限流客户端响应头
*/
HideClientHeaders?: boolean;
/**
* 排队时间
*/
LineUpTime?: number;
/**
* 是否开启请求排队
*/
IsDelay?: boolean;
/**
* 基础限流
注意:此字段可能返回 null,表示取不到有效值。
*/
BasicLimitQpsThresholds?: Array<QpsThreshold>;
/**
* 参数限流的规则
注意:此字段可能返回 null,表示取不到有效值。
*/
LimitRules?: Array<LimitRule>;
}
/**
* DescribeConfigFileRelease请求参数结构体
*/
export interface DescribeConfigFileReleaseRequest {
/**
* TSE实例id
*/
InstanceId: string;
/**
* 命名空间名称
*/
Namespace?: string;
/**
* 配置分组名称
*/
Group?: string;
/**
* 配置文件名称
*/
Name?: string;
/**
* 配置文件发布名称
*/
ReleaseName?: string;
/**
* 配置文件发布Id
*/
Id?: string;
}
/**
* DescribeCloudNativeAPIGatewayConfig请求参数结构体
*/
export interface DescribeCloudNativeAPIGatewayConfigRequest {
/**
* 云原生API网关实例ID。
*/
GatewayId: string;
/**
* 分组id,不填时为默认分组
*/
GroupId?: string;
}
/**
* Kong Upstream中的Target
*/
export interface KongTarget {
/**
* Host
*/
Host: string;
/**
* 端口
*/
Port: number;
/**
* 权重
*/
Weight: number;
/**
* 健康状态
*/
Health?: string;
/**
* 创建时间
*/
CreatedTime?: string;
/**
* Target的来源
*/
Source?: string;
/**
* CVM实例ID
*/
CvmInstanceId?: string;
/**
* CVM实例名称
*/
CvmInstanceName?: string;
/**
* target标签
*/
Tags?: Array<string>;
}
/**
* 实例鉴权信息
*/
export interface SourceInstanceAuth {
/**
* 用户名
*/
Username?: string;
/**
* 账户密码
*/
Password?: string;
/**
* 访问凭据 token
*/
AccessToken?: string;
}
/**
* 扩容策略
*/
export interface AutoScalerPolicy {
/**
* 类型,Pods
*/
Type?: string;
/**
* 数量
*/
Value?: number;
/**
* 扩容周期
*/
PeriodSeconds?: number;
}
/**
* DescribeNacosServerInterfaces返回参数结构体
*/
export interface DescribeNacosServerInterfacesResponse {
/**
* 接口总个数
*/
TotalCount?: number;
/**
* 接口列表
*/
Content?: Array<NacosServerInterface>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 键值对
*/
export interface KVMapping {
/**
* key
*/
Key?: string;
/**
* value
*/
Value?: string;
}
/**
* AI 网关token长度路由配置
*/
export interface AIGWTokenLengthRoute {
/**
* <p>默认tokenizer编码器</p><p>枚举值:</p><ul><li>o200k_base: OpenApi o200k_base</li><li>cl100k_base: OpenApi cl100k_base</li><li>p50k_base: OpenApi p50k_base</li><li>r50k_base: OpenApi r50k_base</li></ul>
*/
DefaultEncodingName?: string;
/**
* <p>token 计数失败、规则为空或未命中任何规则时执行的默认二级路由(暂时只能选择一个指定模型路由)</p>
*/
DefaultTarget?: AIGWLLMModelServiceSubRoute;
/**
* <p>规则</p>
*/
Rules?: Array<AIGWTokenLengthRouteRule>;
}
/**
* 环境具体信息
*/
export interface EnvInfo {
/**
* 环境名称
*/
EnvName: string;
/**
* 环境对应的网络信息
*/
VpcInfos: Array<VpcInfo>;
/**
* 云硬盘容量
*/
StorageCapacity: number;
/**
* 运行状态
*/
Status?: string;
/**
* Admin service 访问地址
*/
AdminServiceIp?: string;
/**
* Config service访问地址
*/
ConfigServiceIp?: string;
/**
* 是否开启config-server公网
*/
EnableConfigInternet?: boolean;
/**
* config-server公网访问地址
*/
ConfigInternetServiceIp?: string;
/**
* 规格ID
*/
SpecId?: string;
/**
* 环境的节点数
*/
EnvReplica?: number;
/**
* 环境运行的节点数
*/
RunningCount?: number;
/**
* 环境别名
*/
AliasEnvName?: string;
/**
* 环境描述
*/
EnvDesc?: string;
/**
* 客户端带宽
*/
ClientBandWidth?: number;
/**
* 客户端内网开关
*/
EnableConfigIntranet?: boolean;
}
/**
* ModifyCloudNativeAPIGatewayConsumer返回参数结构体
*/
export interface ModifyCloudNativeAPIGatewayConsumerResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 定时伸缩配置参数
*/
export interface CloudNativeAPIGatewayStrategyCronScalerConfigParam {
/**
* 定时伸缩周期
*/
Period?: string;
/**
* 定时伸缩开始时间
*/
StartAt?: string;
/**
* 定时伸缩目标节点数,不超过指标伸缩中定义的最大节点数
*/
TargetReplicas?: number;
/**
* 定时伸缩cron表达式,无需输入
*/
Crontab?: string;
}
/**
* DeleteGovernanceInstances请求参数结构体
*/
export interface DeleteGovernanceInstancesRequest {
/**
* tse实例id。
*/
InstanceId: string;
/**
* 要删除的服务实例信息。
*/
GovernanceInstances: Array<GovernanceInstanceUpdate>;
}
/**
* 配置文件模板
*/
export interface ConfigFileTemplate {
/**
* 配置文件模板id
*/
Id?: number;
/**
* 配置文件模板名称
*/
Name?: string;
/**
* 配置文件模板内容
*/
Content?: string;
/**
* 配置文件模板格式
*/
Format?: string;
/**
* 配置文件模板注释
*/
Comment?: string;
/**
* 配置文件模板创建时间
*/
CreateTime?: string;
/**
* 配置文件模板创建者
*/
CreateBy?: string;
/**
* 配置文件模板修改时间
*/
ModifyTime?: string;
/**
* 配置文件模板修改者
*/
ModifyBy?: string;
}
/**
* 网关实例策略
*/
export interface CloudNativeAPIGatewayStrategy {
/**
* 策略ID
*/
StrategyId?: string;
/**
* 策略名称
*/
StrategyName?: string;
/**
* 创建时间
*/
CreateTime?: string;
/**
* 更新时间
*/
ModifyTime?: string;
/**
* 策略描述
*/
Description?: string;
/**
* 弹性伸缩配置
*/
Config?: CloudNativeAPIGatewayStrategyAutoScalerConfig;
/**
* 网关实例ID
*/
GatewayId?: string;
/**
* 定时伸缩配置
*/
CronConfig?: CloudNativeAPIGatewayStrategyCronScalerConfig;
/**
* 最大节点数
注意:此字段可能返回 null,表示取不到有效值。
* @deprecated
*/
MaxReplicas?: number;
}
/**
* LLM-单模型内降级规则
*/
export interface CloudNativeAPIGatewayLLMModelFallbackRule {
/**
* 备选模型,主模型不可用时将依次按顺序尝试。
*/
FallbackModels?: Array<string>;
}
/**
* UpdateEngineInternetAccess返回参数结构体
*/
export interface UpdateEngineInternetAccessResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteCloudNativeAPIGatewayRouteRateLimit请求参数结构体
*/
export interface DeleteCloudNativeAPIGatewayRouteRateLimitRequest {
/**
* 网关Id
*/
GatewayId: string;
/**
* 路由Id,或路由名称。
不支持“未命名”
*/
Id: string;
}
/**
* 指标伸缩行为
*/
export interface AutoScalerBehavior {
/**
* 扩容行为配置
*/
ScaleUp?: AutoScalerRules;
/**
* 缩容行为配置
*/
ScaleDown?: AutoScalerRules;
}
/**
* 缓存感知路由
*/
export interface AIGWCacheAwareRouteConfig {
/**
* <p>前缀缓存感知路由模型服务候选列表</p>
*/
Candidates?: Array<AIGWCacheAwareRouteCandidate>;
}
/**
* CreateCloudNativeAPIGatewayPublicNetwork返回参数结构体
*/
export interface CreateCloudNativeAPIGatewayPublicNetworkResponse {
/**
* 返回结果
*/
Result?: CreatePublicNetworkResult;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyGovernanceServices请求参数结构体
*/
export interface ModifyGovernanceServicesRequest {
/**
* tse 实例 id。
*/
InstanceId: string;
/**
* 服务信息。
*/
GovernanceServices: Array<GovernanceServiceInput>;
}
/**
* DescribeConfigFileReleases返回参数结构体
*/
export interface DescribeConfigFileReleasesResponse {
/**
* 总条数
*/
TotalCount?: number;
/**
* 发布列表
*/
Releases?: Array<ConfigFileRelease>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteCloudNativeAPIGatewayServiceRateLimit返回参数结构体
*/
export interface DeleteCloudNativeAPIGatewayServiceRateLimitResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateGovernanceServices请求参数结构体
*/
export interface CreateGovernanceServicesRequest {
/**
* tse 实例 id。
*/
InstanceId: string;
/**
* 服务信息。
*/
GovernanceServices: Array<GovernanceServiceInput>;
}
/**
* 弹性伸缩配置指标
*/
export interface CloudNativeAPIGatewayStrategyAutoScalerConfigMetric {
/**
* 指标类型
- Resource
*/
Type?: string;
/**
* 指标资源名称
- cpu
- memory
*/
ResourceName?: string;
/**
* 指标目标类型,目前只支持百分比Utilization
*/
TargetType?: string;
/**
* 指标目标值
*/
TargetValue?: number;
}
/**
* 云原生API网关节点信息。
*/
export interface CloudNativeAPIGatewayNode {
/**
* 云原生网关节点 id
*/
NodeId?: string;
/**
* 节点 ip
*/
NodeIp?: string;
/**
* Zone id
*/
ZoneId?: string;
/**
* Zone
*/
Zone?: string;
/**
* 分组ID
*/
GroupId?: string;
/**
* 分组名
*/
GroupName?: string;
/**
* 状态
*/
Status?: string;
/**
* 节点权重
*/
Weight?: number;
/**
* 是否默认权重
*/
IsDefaultWeight?: boolean;
}
/**
* ModifyNetworkAccessStrategy返回参数结构体
*/
export interface ModifyNetworkAccessStrategyResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyAutoScalerResourceStrategy请求参数结构体
*/
export interface ModifyAutoScalerResourceStrategyRequest {
/**
* 网关实例ID
*/
GatewayId: string;
/**
* 策略ID
*/
StrategyId: string;
/**
* 策略名称
*/
StrategyName?: string;
/**
* 策略描述
*/
Description?: string;
/**
* 指标伸缩配置
*/
Config?: CloudNativeAPIGatewayStrategyAutoScalerConfig;
/**
* 定时伸缩配置
* @deprecated
*/
CronScalerConfig?: CloudNativeAPIGatewayStrategyCronScalerConfig;
/**
* 最大节点数
* @deprecated
*/
MaxReplicas?: number;
/**
* 指标伸缩配置
*/
CronConfig?: CloudNativeAPIGatewayStrategyCronScalerConfig;
}
/**
* UnbindAutoScalerResourceStrategyFromGroups请求参数结构体
*/
export interface UnbindAutoScalerResourceStrategyFromGroupsRequest {
/**
* 网关实例ID
*/
GatewayId: string;
/**
* 策略ID
*/
StrategyId: string;
/**
* 网关分组ID列表
*/
GroupIds: Array<string>;
}
/**
* 公网负载均衡配置
*/
export interface InternetConfig {
/**
* 公网地址版本,可选:"IPV4" | "IPV6" 。不填默认 IPV4 。
*/
InternetAddressVersion?: string;
/**
* 公网付费类型,当前仅可选:"BANDWIDTH"。不填默认为 "BANDWIDTH"
*/
InternetPayMode?: string;
/**
* 公网带宽。
*/
InternetMaxBandwidthOut?: number;
/**
* 负载均衡描述
*/
Description?: string;
/**
* 负载均衡的规格类型,支持clb.c2.medium、clb.c3.small、clb.c3.medium、clb.c4.small、clb.c4.medium、clb.c4.large、clb.c4.xlarge,不传为共享型。
*/
SlaType?: string;
/**
* 负载均衡是否多可用区
*/
MultiZoneFlag?: boolean;
/**
* 主可用区
*/
MasterZoneId?: string;
/**
* 备可用区
*/
SlaveZoneId?: string;
}
/**
* DeleteCloudNativeAPIGatewayPublicNetwork请求参数结构体
*/
export interface DeleteCloudNativeAPIGatewayPublicNetworkRequest {
/**
* 云原生API网关实例ID。
*/
GatewayId: string;
/**
* 分组id,kong类型时必填
*/
GroupId?: string;
/**
* 公网类型
- IPV4 (默认值)
- IPV6
*/
InternetAddressVersion?: string;
/**
* 公网ip,存在多个公网时必填
*/
Vip?: string;
}
/**
* 配置发布版本信息
*/
export interface ReleaseVersion {
/**
* 配置发布的版本
*/
Name?: string;
/**
* 是否生效
*/
Active?: boolean;
/**
* 配置发布的ID
*/
Id?: string;
/**
* 配置发布的命名空间
*/
Namespace?: string;
/**
* 配置发布的分组
*/
Group?: string;
/**
* 配置发布的文件名
*/
FileName?: string;
}
/**
* DeleteEngine返回参数结构体
*/
export interface DeleteEngineResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateConfigFileGroup返回参数结构体
*/
export interface CreateConfigFileGroupResponse {
/**
* 是否创建成功
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateGovernanceAlias请求参数结构体
*/
export interface CreateGovernanceAliasRequest {
/**
* tse实例id。
*/
InstanceId: string;
/**
* 服务别名
*/
Alias: string;
/**
* 服务别名命名空间
*/
AliasNamespace: string;
/**
* 服务别名所指向的服务名
*/
Service: string;
/**
* 服务别名所指向的命名空间
*/
Namespace: string;
/**
* 服务别名描述
*/
Comment?: string;
}
/**
* ModifyCloudNativeAPIGatewayService请求参数结构体
*/
export interface ModifyCloudNativeAPIGatewayServiceRequest {
/**
* 网关ID
*/
GatewayId: string;
/**
* 服务名称
*/
Name: string;
/**
* 请求协议:
- https
- http
- tcp
- udp
*/
Protocol: string;
/**
* 超时时间,单位ms
*/
Timeout: number;
/**
* 重试次数
*/
Retries: number;
/**
* 服务类型:
- Kubernetes
- Registry
- IPList
- HostIP
- Scf
*/
UpstreamType: string;
/**
* 服务配置
*/
UpstreamInfo: KongUpstreamInfo;
/**
* 服务ID
*/
ID: string;
/**
* 请求路径
*/
Path?: string;
}
/**
* DescribeAutoScalerResourceStrategyBindingGroups请求参数结构体
*/
export interface DescribeAutoScalerResourceStrategyBindingGroupsRequest {
/**
* 网关实例ID
*/
GatewayId: string;
/**
* 策略ID
*/
StrategyId: string;
/**
* 查询偏移量
*/
Offset?: number;
/**
* 查询数量限制
*/
Limit?: number;
}
/**
* DescribeWafProtection请求参数结构体
*/
export interface DescribeWafProtectionRequest {
/**
* 网关ID
*/
GatewayId: string;
/**
* 防护资源的类型。
- Global 实例
- Service 服务
- Route 路由
- Object 对象
* @deprecated
*/
Type?: string;
/**
* 防护资源类型列表,支持查询多个类型(Global、Service、Route、Object)。为空时,默认查询Global类型。
*/
TypeList?: Array<string>;
}
/**
* DescribeAutoScalerResourceStrategies请求参数结构体
*/
export interface DescribeAutoScalerResourceStrategiesRequest {
/**
* 网关实例ID
*/
GatewayId: string;
/**
* 策略ID
*/
StrategyId?: string;
}
/**
* 参数限流的规则
*/
export interface LimitRule {
/**
* 请求匹配条件
*/
Filters?: Array<RuleFilter>;
/**
* 参数限流依据组合
*/
LimitBy?: Array<KeyValue>;
/**
* 限流阈值
*/
QpsThresholds?: Array<QpsThreshold>;
/**
* 精确限流阈值
*/
AccurateQpsThresholds?: Array<AccurateQpsThreshold>;
}
/**
* 限流规则的Filter
*/
export interface RuleFilter {
/**
* 限流条件的Key
*/
Key?: string;
/**
* 限流条件的Values
*/
Values?: Array<string>;
/**
* 操作符
*/
Operator?: string;
/**
* header或query对应的name
*/
Name?: string;
}
/**
* DeleteCloudNativeAPIGatewayCORS请求参数结构体
*/
export interface DeleteCloudNativeAPIGatewayCORSRequest {
/**
* 网关ID
*/
GatewayId: string;
/**
* 跨域插件绑定的资源类型:route|service
*/
SourceType: string;
/**
* 路由或服务的id
*/
SourceId: string;
}
/**
* DeleteCloudNativeAPIGatewayConsumer请求参数结构体
*/
export interface DeleteCloudNativeAPIGatewayConsumerRequest {
/**
* 网关实例id
*/
GatewayId: string;
/**
* 消费者ID
*/
ConsumerId: string;
}
/**
* DescribeGovernanceInstances请求参数结构体
*/
export interface DescribeGovernanceInstancesRequest {
/**
* 实例所在的服务名。
*/
Service: string;
/**
* 实例所在命名空间名。
*/
Namespace: string;
/**
* tse实例id。
*/
InstanceId: string;
/**
* 根据实例ip过滤,多个ip使用英文逗号分隔。
*/
Host?: string;
/**
* 根据实例版本过滤。
*/
InstanceVersion?: string;
/**
* 根据实例协议过滤。
*/
Protocol?: string;
/**
* 根据实例健康状态过滤。false:表示不健康,true:表示健康。
*/
HealthStatus?: boolean;
/**
* 根据实例隔离状态过滤。false:表示非隔离,true:表示隔离中。
*/
Isolate?: boolean;
/**
* 根据元数据信息过滤。目前只支持一组元数据键值,若传了多个键值对,只会以第一个过滤。
*/
Metadatas?: Array<Metadata>;
/**
* 偏移量,默认为0。
*/
Offset?: number;
/**
* 返回数量,默认为20,最大值为100。
*/
Limit?: number;
/**
* 地域
*/
Location?: Location;
}
/**
* DescribeGovernanceServiceContracts请求参数结构体
*/
export interface DescribeGovernanceServiceContractsRequest {
/**
* 北极星引擎实例ID
*/
InstanceId: string;
/**
* 分页偏移量
*/
Offset?: number;
/**
* 分页条数
*/
Limit?: number;
/**
* 命名空间
*/
Namespace?: string;
/**
* 服务名
*/
Service?: string;
/**
* 契约名称
*/
Name?: string;
/**
* 契约版本
*/
ContractVersion?: string;
/**
* 契约协议
*/
Protocol?: string;
/**
* 是否只展示基本信息
*/
Brief?: boolean;
}
/**
* 实例信息
*/
export interface GovernanceInstanceUpdate {
/**
* 实例所在服务名。
*/
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;
/**
* 治理中心服务实例id。
*/
Id?: string;
/**
* 元数据信息。
*/
Metadatas?: Array<Metadata>;
}
/**
* 配置文件持久化
*/
export interface ConfigFilePersistent {
/**
* 文件编码
*/
Encoding?: string;
/**
* 文件下发路径
*/
Path?: string;
/**
* 文件后置命令
*/
PostCmd?: string;
}
/**
* kong后端upstream列表
*/
export interface KongUpstreamList {
/**
* 无
*/
UpstreamList?: Array<KongUpstreamPreview>;
}
/**
* DescribeConfigFiles请求参数结构体
*/
export interface DescribeConfigFilesRequest {
/**
* 命名空间名称
*/
Namespace: string;
/**
* TSE实例id
*/
InstanceId?: string;
/**
* 组名
*/
Group?: string;
/**
* 配置文件名称
*/
Name?: string;
/**
* 标签列表
*/
Tags?: Array<ConfigFileTag>;
/**
* 返回数量,默认为20,最大值为100。
*/
Limit?: number;
/**
* 偏移量,默认为0。
*/
Offset?: number;
/**
* 配置文件ID
*/
Id?: string;
}
/**
* DeleteCloudNativeAPIGatewayRoute请求参数结构体
*/
export interface DeleteCloudNativeAPIGatewayRouteRequest {
/**
* 网关ID
*/
GatewayId: string;
/**
* 路由的ID或名字,不支持名称“未命名”
*/
Name: string;
}
/**
* DescribeConfigFileReleases请求参数结构体
*/
export interface DescribeConfigFileReleasesRequest {
/**
* 实例id
*/
InstanceId: string;
/**
* 条数
*/
Limit: number;
/**
* 偏移量
*/
Offset: number;
/**
* 命名空间
*/
Namespace?: string;
/**
* 配置分组
*/
Group?: string;
/**
* 文件名称
*/
FileName?: string;
/**
* 只保护处于使用状态
*/
OnlyUse?: boolean;
/**
* 发布名称
*/
ReleaseName?: string;
/**
* 排序字段,mtime/version/name
,默认version
*/
OrderField?: string;
/**
* 排序,asc/desc,默认 desc
*/
OrderDesc?: string;
/**
* 配置发布ID
*/
Id?: string;
}
/**
* ModifyCloudNativeAPIGatewayServiceRateLimit返回参数结构体
*/
export interface ModifyCloudNativeAPIGatewayServiceRateLimitResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 弹性伸缩策略
*/
export interface CloudNativeAPIGatewayStrategyAutoScalerConfig {
/**
* 最大副本数
*/
MaxReplicas?: number;
/**
* 指标列表
注意:此字段可能返回 null,表示取不到有效值。
*/
Metrics?: Array<CloudNativeAPIGatewayStrategyAutoScalerConfigMetric>;
/**
* 是否开启指标伸缩
注意:此字段可能返回 null,表示取不到有效值。
* @deprecated
*/
Enabled?: boolean;
/**
* 创建时间
注意:此字段可能返回 null,表示取不到有效值。
* @deprecated
*/
CreateTime?: string;
/**
* 修改时间
注意:此字段可能返回 null,表示取不到有效值。
* @deprecated
*/
ModifyTime?: string;
/**
* 弹性策略ID
注意:此字段可能返回 null,表示取不到有效值。
* @deprecated
*/
StrategyId?: string;
/**
* 指标配置ID
注意:此字段可能返回 null,表示取不到有效值。
* @deprecated
*/
AutoScalerId?: string;
/**
* 指标伸缩行为配置
注意:此字段可能返回 null,表示取不到有效值。
*/
Behavior?: AutoScalerBehavior;
}
/**
* 灰度规则中的条件配置
*/
export interface CloudNativeAPIGatewayCanaryRuleCondition {
/**
* 条件类型,支持 path, method, query, header, cookie, body 和 system。
*/
Type: string;
/**
* 参数名
*/
Key?: string;
/**
* 操作符,支持 "le", "eq", "lt", "ne", "ge", "gt", "regex", "exists", "in", "not in", "prefix" ,"exact", "regex" 等
*/
Operator?: string;
/**
* 目标参数值
*/
Value?: string;
/**
* 分隔符,当 Operator 为 in 或者 not in 时生效。支持值为英文逗号,英文分号,空格,换行符。
*/
Delimiter?: string;
/**
* 全局配置 Id
*/
GlobalConfigId?: string;
/**
* 全局配置名称
*/
GlobalConfigName?: string;
}
/**
* DescribeGov