tencentcloud-sdk-nodejs
Version:
2,208 lines (2,202 loc) • 333 kB
TypeScript
/**
* DescribeTargetGroupList返回参数结构体
*/
export interface DescribeTargetGroupListResponse {
/**
* <p>显示的结果数量。</p>
*/
TotalCount?: number;
/**
* <p>显示的目标组信息集合。</p>
*/
TargetGroupSet?: Array<TargetGroupInfo>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 七层规则对象
*/
export interface RulesItems {
/**
* 规则id
*/
LocationId?: string;
/**
* 域名
*/
Domain?: string;
/**
* uri
*/
Url?: string;
/**
* 绑定的后端对象
*/
Targets?: Array<LbRsTargets>;
}
/**
* 暂做保留,一般用户无需关注。
*/
export interface ExtraInfo {
/**
* 是否开通VIP直通
*/
ZhiTong?: boolean;
/**
* TgwGroup名称
*/
TgwGroupName?: string;
}
/**
* DescribeRewrite返回参数结构体
*/
export interface DescribeRewriteResponse {
/**
* 重定向转发规则构成的数组,若无重定向规则,则返回空数组。
*/
RewriteSet?: Array<RuleOutput>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 模型路由关联的模型
*/
export interface ModelRouterModel {
/**
* <p>模型名称</p>
*/
ModelName: string;
/**
* <p>所属厂商</p>
*/
Provider: string;
/**
* <p>模型类型。</p><p>枚举值:</p><ul><li>BYOK: BYOK类型</li><li>Platform: 平台类型</li></ul>
*/
Type: string;
/**
* <p>服务商/模型 ID(byok_model.model_id,形如 model-xxxxxxxx;Platform 类型不传)</p>
*/
ServiceProviderId?: string;
}
/**
* DescribeLoadBalancerTraffic返回参数结构体
*/
export interface DescribeLoadBalancerTrafficResponse {
/**
* 按出带宽从高到低排序后的负载均衡信息。
*/
LoadBalancerTraffic?: Array<LoadBalancerTraffic>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 修改节点标签的数据类型
*/
export interface RsTagRule {
/**
* <p>负载均衡监听器 ID。</p>
*/
ListenerId: string;
/**
* <p>要修改标签的后端机器列表。</p>
*/
Targets: Array<Target>;
/**
* <p>转发规则的ID,七层规则时需要此参数,4层规则不需要。</p>
*/
LocationId?: string;
/**
* <p>后端服务修改后的标签。此参数的优先级低于前述<a href="https://cloud.tencent.com/document/api/214/30694#Target">Target</a>中的Tag参数,即最终的标签以Target中的Tag参数值为准,仅当Target中的Tag参数为空时,才以RsTagRule中的Tag参数为准。</p>
*/
Tag?: string;
}
/**
* DescribeCustomizedConfigList返回参数结构体
*/
export interface DescribeCustomizedConfigListResponse {
/**
* 配置列表
*/
ConfigList?: Array<ConfigListItem>;
/**
* 配置数目
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 异步任务信息
*/
export interface Job {
/**
* <p>接口名称</p>
*/
ApiName?: string;
/**
* <p>请求ID</p>
*/
RequestId?: string;
/**
* <p>异步任务状态</p><p>枚举值:</p><ul><li>Processing: 进行中</li><li>Succeeded: 成功</li><li>Failed: 失败</li></ul>
*/
Status?: string;
/**
* <p>资源ID</p>
*/
ResourceIds?: Array<string>;
}
/**
* CreateModelRouterResourcePackage请求参数结构体
*/
export interface CreateModelRouterResourcePackageRequest {
/**
* <p>模型路由资源包容量</p><p>取值范围:[1000, 10000000]</p><p>单次购买的模型路由资源包容量下限为1000,上限为10000000</p>
*/
ModelRouterResourcePackageAmount: number;
/**
* <p>是否自动续订。</p><p>0:不自动续订, 1:用尽到期续订</p>
*/
AutoPurchaseFlag?: number;
/**
* <p>该笔订单是否自动选择代金券</p><p>默认值:false(不自动选择代金券)</p><p>true时会为本笔订单自动匹配满足条件、最优惠的代金券</p>
*/
AutoVoucher?: boolean;
}
/**
* DeleteBudgets请求参数结构体
*/
export interface DeleteBudgetsRequest {
/**
* <p>要删除的Budget ID列表。</p>
*/
BudgetIds: Array<string>;
}
/**
* AssociateTargetGroups请求参数结构体
*/
export interface AssociateTargetGroupsRequest {
/**
* 绑定的关系数组,目标组类型需要一致。
一次请求最多支持20个。
*/
Associations: Array<TargetGroupAssociation>;
}
/**
* RemoveModelRewrite请求参数结构体
*/
export interface RemoveModelRewriteRequest {
/**
* <p>模型路由实例 ID。</p>
*/
ModelRouterId: string;
/**
* <p>要删除的源模型名(重写规则的 key)。</p><p>长度 1-255 字符;支持特殊值 <code>default</code> 表示删除兜底规则。</p><p>当指定的 SourceModel 当前不存在重写规则时,请求幂等成功。</p>
*/
SourceModel: string;
}
/**
* 模型别名对象
*/
export interface ModelAlias {
/**
* <p>模型积分系数配置,包含 <code>InputCoefficient</code>、<code>InputCachedCoefficient</code> 和 <code>OutputCoefficient</code>。</p><p>未配置时输入系数默认为 25,缓存命中输入系数默认为 3,输出系数默认为 100。</p>
*/
Coefficient?: Coefficient;
/**
* <p>模型别名名称。</p><p>若用户配置了模型别名,则为该别名;未配置时为原始模型名称。</p>
*/
ModelAliasName?: string;
/**
* <p>该模型别名下各 BYOK 实例(ServiceProvider)的积分系数明细,体现 ModelAlias 与 ServiceProvider 的层级关系。</p><p>默认返回该别名引用的全部实例;某实例返回 <code>Coefficient</code> 表示其单独配置了 ServiceProvider 维度系数,否则继承顶层 ModelAlias 的 <code>Coefficient</code>。</p><p>该别名当前无有效 BYOK 引用时返回空数组。</p>
*/
ServiceProviderCoefficientSet?: Array<ServiceProviderCoefficient>;
/**
* <p>模型来源。</p><p>枚举值:</p><ul><li>BYOK:用户 BYOK 配置的模型。</li></ul>
*/
Source?: string;
/**
* <p>状态</p><p>枚举值:</p><ul><li>Active: 正常可用</li><li>Configuring: 变配中</li><li>ConfigureFailed: 变配失败</li></ul>
*/
Status?: string;
}
/**
* CreateBudget请求参数结构体
*/
export interface CreateBudgetRequest {
/**
* <p>预算配置数组。</p><p>数组长度最大为3,最多可同时配置1d、7d、30d三个刷新周期,且每种刷新周期只能出现一次。BudgetResetAt不支持作为入参设置,系统会按配置的刷新周期自动维护刷新时间。</p>
*/
BudgetConfigs?: Array<BudgetConfigInput>;
/**
* <p>Budget名称。</p><p>不传默认为 '-'。</p>
*/
BudgetName?: string;
/**
* <p>Budget限速配置。</p>
*/
RateLimitConfig?: RateLimitConfigForBudget;
/**
* <p>创建Budget时同时关联的资源列表。</p><p>仅支持企业型模型路由实例和企业型实例下的Key。如果资源不存在或不可关联,创建请求失败;资源已关联其他Budget时将替换为新创建的Budget。</p>
*/
Resources?: Array<BudgetResource>;
}
/**
* RegisterFunctionTargets请求参数结构体
*/
export interface RegisterFunctionTargetsRequest {
/**
* 负载均衡实例 ID。
*/
LoadBalancerId: string;
/**
* 负载均衡监听器 ID。
*/
ListenerId: string;
/**
* 待绑定的云函数列表。
*/
FunctionTargets: Array<FunctionTarget>;
/**
* 目标转发规则的 ID,当将云函数绑定到七层转发规则时,必须输入此参数或 Domain+Url 参数。
*/
LocationId?: string;
/**
* 目标转发规则的域名,若已经输入 LocationId 参数,则本参数不生效。
*/
Domain?: string;
/**
* 目标转发规则的 URL,若已经输入 LocationId 参数,则本参数不生效。
*/
Url?: string;
}
/**
* DeleteUserGroups返回参数结构体
*/
export interface DeleteUserGroupsResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* InquirePriceRefundModelRouterResourcePackage返回参数结构体
*/
export interface InquirePriceRefundModelRouterResourcePackageResponse {
/**
* <p>待退款的模型路由资源包可退价格</p>
*/
ModelRouterResourcePackageRefundPrice?: Array<ModelRouterResourcePackageRefundPrice>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyModelRouterSecurityGroups请求参数结构体
*/
export interface ModifyModelRouterSecurityGroupsRequest {
/**
* <p>模型路由实例ID</p>
*/
ModelRouterId: string;
/**
* <p>需要绑定的安全组ID列表</p>
*/
SecurityGroups: Array<string>;
}
/**
* 监听器或者转发规则绑定的目标组基本信息
*/
export interface BasicTargetGroupInfo {
/**
* 目标组ID
*/
TargetGroupId?: string;
/**
* 目标组名称
*/
TargetGroupName?: string;
/**
* 目标组权重
*/
Weight?: number;
}
/**
* 关联的模型路由实例
*/
export interface AssociatedModelRouterItem {
/**
* <p>模型路由实例ID</p>
*/
ModelRouterId?: string;
}
/**
* DescribeTargetGroupInstanceStatus返回参数结构体
*/
export interface DescribeTargetGroupInstanceStatusResponse {
/**
* 健康检查后端rs状态列表
*/
TargetGroupInstanceSet?: Array<TargetGroupInstanceStatus>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeClassicalLBByInstanceId返回参数结构体
*/
export interface DescribeClassicalLBByInstanceIdResponse {
/**
* 负载均衡相关信息列表。
*/
LoadBalancerInfoList: Array<ClassicalLoadBalancerInfo>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteModel返回参数结构体
*/
export interface DeleteModelResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateBYOKNetwork返回参数结构体
*/
export interface CreateBYOKNetworkResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyServiceProviderModelAttributes返回参数结构体
*/
export interface ModifyServiceProviderModelAttributesResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteModelRouters请求参数结构体
*/
export interface DeleteModelRoutersRequest {
/**
* <p>模型路由实例ID列表</p>
*/
ModelRouterIds?: Array<string>;
}
/**
* DescribeTargetGroups返回参数结构体
*/
export interface DescribeTargetGroupsResponse {
/**
* 显示的结果数量。
*/
TotalCount?: number;
/**
* 显示的目标组信息集合。
*/
TargetGroupSet?: Array<TargetGroupInfo>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyLoadBalancerSla返回参数结构体
*/
export interface ModifyLoadBalancerSlaResponse {
/**
* 订单号。
*/
DealName?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeModelNames请求参数结构体
*/
export interface DescribeModelNamesRequest {
/**
* <p>分页偏移量(>=0)</p>
*/
Offset?: number;
/**
* <p>每页数量(1-100)</p>
*/
Limit?: number;
/**
* <p>过滤PrivateCustom类型自建模型。如果传递了此参数,则只返回具有相同VPC Id的模型。</p>
*/
VpcId?: string;
}
/**
* CreateUserGroup请求参数结构体
*/
export interface CreateUserGroupRequest {
/**
* <p>模型路由实例ID。用户组将创建在该实例下。</p>
*/
ModelRouterId: string;
/**
* <p>用户组名称。必填。同一模型路由实例下名称唯一,长度不超过255个字符。</p>
*/
UserGroupName: string;
/**
* <p>建组时直接关联的预算 ID(须为已存在的 Budget)。关联后由该 Budget 统一管理本组的消费上限与限速。不传表示不关联预算,可建组后再用 AssociateBudget 关联。</p>
*/
BudgetId?: string;
/**
* <p>用户组意图路由白名单(ir-xxx)。每一项须为该实例已创建的意图路由名。命中意图路由名时其内部真实模型自动豁免白名单。为空表示不授权任何意图路由。</p>
*/
IntentRouters?: Array<string>;
/**
* <p>建组时同时绑定的已有 Key ID 列表,最多100个。每个 Key 须属于同一模型路由实例。建组与绑定为一个原子异步任务,任一 Key 失败则整组创建回滚。不传表示建空组。</p>
*/
KeyIds?: Array<string>;
/**
* <p>用户组真实模型白名单。每一项须为该实例已关联的模型名。为空表示不在用户组层限制真实模型(按实例层白名单生效)。</p>
*/
Models?: Array<string>;
/**
* <p>标签列表,最多50个。</p>
*/
Tags?: Array<TagInfo>;
}
/**
* DeregisterModelsFromServiceProvider返回参数结构体
*/
export interface DeregisterModelsFromServiceProviderResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 加入了12306黑名单的IP
*/
export interface BlockedIP {
/**
* 黑名单IP
*/
IP?: string;
/**
* 加入黑名单的时间
*/
CreateTime?: string;
/**
* 过期时间
*/
ExpireTime?: string;
}
/**
* DeleteModel请求参数结构体
*/
export interface DeleteModelRequest {
/**
* <p>服务提供商ID列表</p>
*/
ServiceProviderIds: Array<string>;
}
/**
* DescribeListeners返回参数结构体
*/
export interface DescribeListenersResponse {
/**
* 监听器列表。
*/
Listeners?: Array<Listener>;
/**
* 总的监听器个数(根据端口、协议、监听器ID过滤后)。
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AutoRewrite请求参数结构体
*/
export interface AutoRewriteRequest {
/**
* 负载均衡实例ID。
*/
LoadBalancerId: string;
/**
* HTTPS:443监听器的ID。
*/
ListenerId: string;
/**
* HTTPS:443监听器下需要重定向的域名,若不填,则对HTTPS:443监听器下的所有域名都设置重定向。
*/
Domains?: Array<string>;
/**
* 重定向状态码,可取值301,302,307。
*/
RewriteCodes?: Array<number | bigint>;
/**
* 重定向是否携带匹配的URL。
*/
TakeUrls?: Array<boolean>;
}
/**
* DescribeModelRouterResourcePackageDeduction返回参数结构体
*/
export interface DescribeModelRouterResourcePackageDeductionResponse {
/**
* <p>模型路由资源包抵扣信息</p>
*/
ModelRouterResourcePackageDeductionSet?: Array<ModelRouterResourcePackageDeduction>;
/**
* <p>符合查询条件的详情信息总数</p>
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeLoadBalancerTraffic请求参数结构体
*/
export interface DescribeLoadBalancerTrafficRequest {
/**
* 负载均衡所在地域,不传默认返回所有地域负载均衡。
*/
LoadBalancerRegion?: string;
}
/**
* DescribeClassicalLBHealthStatus返回参数结构体
*/
export interface DescribeClassicalLBHealthStatusResponse {
/**
* 后端健康状态列表。
*/
HealthList?: Array<ClassicalHealth>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AssociateModelsToModelRouter返回参数结构体
*/
export interface AssociateModelsToModelRouterResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeModelAssociations请求参数结构体
*/
export interface DescribeModelAssociationsRequest {
/**
* <p>模型路由实例ID</p>
*/
ModelRouterId: string;
/**
* <p>翻页限制</p><p>取值范围:[1, 100]</p><p>默认值:20</p>
*/
Limit?: number;
/**
* <p>翻页偏移量</p><p>默认值:0</p>
*/
Offset?: number;
}
/**
* 规格可用性
*/
export interface SpecAvailability {
/**
* 规格类型。
<li>clb.c2.medium(标准型)</li><li>clb.c3.small(高阶型1)</li><li>clb.c3.medium(高阶型2)</li>
<li>clb.c4.small(超强型1)</li><li>clb.c4.medium(超强型2)</li><li>clb.c4.large(超强型3)</li><li>clb.c4.xlarge(超强型4)</li><li>shared(共享型)</li>
*/
SpecType?: string;
/**
* 规格可用性。资源可用性,"Available":可用,"Unavailable":不可用
*/
Availability?: string;
}
/**
* 健康检查信息。
注意,自定义探测相关参数 目前只有少量区域灰度支持。
*/
export interface HealthCheck {
/**
* 是否开启健康检查:1(开启)、0(关闭)。
默认为开启。
*/
HealthSwitch?: number;
/**
* 健康检查的响应超时时间,可选值:2~60,默认值:2,单位:秒。响应超时时间要小于检查间隔时间。
*/
TimeOut?: number;
/**
* 健康检查探测间隔时间,默认值:5,IPv4 CLB实例的取值范围为:2-300,IPv6 CLB 实例的取值范围为:5-300。单位:秒。
说明:部分老旧 IPv4 CLB实例的取值范围为:5-300。
*/
IntervalTime?: number;
/**
* 健康阈值,默认值:3,表示当连续探测三次健康则表示该转发正常,可选值:2~10,单位:次。
*/
HealthNum?: number;
/**
* 不健康阈值,默认值:3,表示当连续探测三次不健康则表示该转发异常,可选值:2~10,单位:次。
*/
UnHealthNum?: number;
/**
* 健康检查状态码(仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式)。可选值:1~31,默认 31。
1 表示探测后返回值 1xx 代表健康,2 表示返回 2xx 代表健康,4 表示返回 3xx 代表健康,8 表示返回 4xx 代表健康,16 表示返回 5xx 代表健康。若希望多种返回码都可代表健康,则将相应的值相加。
注意:此字段可能返回 null,表示取不到有效值。
*/
HttpCode?: number;
/**
* 健康检查路径(仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式)。
注意:此字段可能返回 null,表示取不到有效值。
*/
HttpCheckPath?: string;
/**
* 健康检查域名,将在HTTP协议 Host 头字段中携带。(仅适用于HTTP/HTTPS监听器和TCP监听器的HTTP健康检查方式。针对TCP监听器,当使用HTTP健康检查方式时,该参数为必填项)。
注意:此字段可能返回 null,表示取不到有效值。
*/
HttpCheckDomain?: string;
/**
* 健康检查方法(仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式),默认值:HEAD,可选值HEAD或GET。
注意:此字段可能返回 null,表示取不到有效值。
*/
HttpCheckMethod?: string;
/**
* 自定义探测相关参数。健康检查端口,默认为后端服务的端口,除非您希望指定特定端口,否则建议留空。传参数值-1可恢复默认设置。(仅适用于TCP/UDP监听器)。
注意:此字段可能返回 null,表示取不到有效值。
*/
CheckPort?: number;
/**
* 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时,必填此字段,代表健康检查的输入格式,可取值:HEX或TEXT;取值为HEX时,SendContext和RecvContext的字符只能在0123456789ABCDEF中选取且长度必须是偶数位。(仅适用于TCP/UDP监听器)
注意:此字段可能返回 null,表示取不到有效值。
*/
ContextType?: string;
/**
* 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时,必填此字段,代表健康检查发送的请求内容,只允许ASCII可见字符,最大长度限制500。(仅适用于TCP/UDP监听器)。
注意:此字段可能返回 null,表示取不到有效值。
*/
SendContext?: string;
/**
* 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时,必填此字段,代表健康检查返回的结果,只允许ASCII可见字符,最大长度限制500。(仅适用于TCP/UDP监听器)。
注意:此字段可能返回 null,表示取不到有效值。
*/
RecvContext?: string;
/**
* 健康检查使用的协议。取值 TCP | HTTP | HTTPS | GRPC | PING | CUSTOM,UDP监听器支持PING/CUSTOM,TCP监听器支持TCP/HTTP/CUSTOM,TCP_SSL/QUIC监听器支持TCP/HTTP,HTTP规则支持HTTP/GRPC,HTTPS规则支持HTTP/HTTPS/GRPC。HTTP监听器默认值为HTTP;TCP、TCP_SSL、QUIC监听器默认值为TCP;UDP监听器默认为PING;HTTPS监听器的CheckType默认值与后端转发协议一致。
*/
CheckType?: string;
/**
* HTTP版本。健康检查协议CheckType的值取HTTP时,必传此字段,代表后端服务的HTTP版本:HTTP/1.0、HTTP/1.1;(仅适用于TCP监听器)
注意:此字段可能返回 null,表示取不到有效值。
*/
HttpVersion?: string;
/**
* 健康检查源IP类型:0(使用LB的VIP作为源IP),1(使用100.64网段IP作为源IP)。
*/
SourceIpType?: number;
/**
* GRPC健康检查状态码(仅适用于后端转发协议为GRPC的规则)。默认值为 12,可输入值为数值、多个数值、或者范围,例如 20 或 20,25 或 0-99
注意:此字段可能返回 null,表示取不到有效值。
*/
ExtendedCode?: string;
}
/**
* DescribeLoadBalancersDetail返回参数结构体
*/
export interface DescribeLoadBalancersDetailResponse {
/**
* 负载均衡详情列表总数。
*/
TotalCount?: number;
/**
* 负载均衡详情列表。
*/
LoadBalancerDetailSet?: Array<LoadBalancerDetail>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DisassociateCustomizedConfig请求参数结构体
*/
export interface DisassociateCustomizedConfigRequest {
/**
* 配置ID
*/
UconfigId: string;
/**
* 解绑的列表
*/
BindList: Array<BindItem>;
}
/**
* CreateTopic请求参数结构体
*/
export interface CreateTopicRequest {
/**
* 日志主题的名称。
*/
TopicName: string;
/**
* 主题分区Partition的数量,不传参默认创建1个,最大创建允许10个,分裂/合并操作会改变分区数量,整体上限50个。
*/
PartitionCount?: number;
/**
* 日志类型,ACCESS:访问日志,HEALTH:健康检查日志,默认ACCESS。
*/
TopicType?: string;
/**
* 存储时间,单位天,默认为 30。
- 日志接入标准存储时,支持1至3600天,值为3640时代表永久保存。
- 日志接入低频存储时,支持7至3600天,值为3640时代表永久保存。
*/
Period?: number;
/**
* 日志主题的存储类型,可选值 HOT(标准存储),COLD(低频存储);默认为HOT。
*/
StorageType?: string;
}
/**
* DeleteListener请求参数结构体
*/
export interface DeleteListenerRequest {
/**
* 负载均衡实例ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。
*/
LoadBalancerId: string;
/**
* 要删除的监听器ID,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
*/
ListenerId: string;
}
/**
* ModifyBlockIPList返回参数结构体
*/
export interface ModifyBlockIPListResponse {
/**
* 异步任务的ID
*/
JodId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* MigrateClassicalLoadBalancers请求参数结构体
*/
export interface MigrateClassicalLoadBalancersRequest {
/**
* 传统型负载均衡ID数组
*/
LoadBalancerIds: Array<string>;
/**
* 独占集群信息
*/
ExclusiveCluster?: ExclusiveCluster;
}
/**
* 目标组绑定的后端服务器
*/
export interface TargetGroupBackend {
/**
* 目标组ID
*/
TargetGroupId?: string;
/**
* 后端服务的类型,可取:CVM、ENI(即将支持)
*/
Type?: string;
/**
* 后端服务的唯一 ID
*/
InstanceId?: string;
/**
* 后端服务的监听端口,全端口段监听器此字段返回0,代表无效端口,即不支持设置。
*/
Port?: number;
/**
* 后端服务的转发权重,取值范围:[0, 100],默认为 10。
*/
Weight?: number;
/**
* 后端服务的外网 IP
*/
PublicIpAddresses?: Array<string>;
/**
* 后端服务的内网 IP
*/
PrivateIpAddresses?: Array<string>;
/**
* 后端服务的实例名称
*/
InstanceName?: string;
/**
* 后端服务被绑定的时间
注意:此字段可能返回 null,表示取不到有效值。
*/
RegisteredTime?: string;
/**
* 弹性网卡唯一ID
*/
EniId?: string;
/**
* 后端服务的可用区ID
*/
ZoneId?: number;
}
/**
* ModifyKeyAttributes返回参数结构体
*/
export interface ModifyKeyAttributesResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyKeysBlockStatus请求参数结构体
*/
export interface ModifyKeysBlockStatusRequest {
/**
* <p>模型路由实例ID</p>
*/
ModelRouterId: string;
/**
* <p>是否停止使用</p>
*/
Blocked: boolean;
/**
* <p>需要修改的Key的ID列表</p>
*/
KeyIds?: Array<string>;
}
/**
* DescribeModelAliases返回参数结构体
*/
export interface DescribeModelAliasesResponse {
/**
* <p>模型别名列表。</p>
*/
ModelAliasSet?: Array<ModelAlias>;
/**
* <p>符合条件的总数。</p>
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyBlockIPList请求参数结构体
*/
export interface ModifyBlockIPListRequest {
/**
* 负载均衡实例ID
*/
LoadBalancerIds: Array<string>;
/**
* 操作类型,可取:
<li> add_customized_field(首次设置header,开启黑名单功能)</li>
<li> set_customized_field(修改header)</li>
<li> del_customized_field(删除header)</li>
<li> add_blocked(添加黑名单)</li>
<li> del_blocked(删除黑名单)</li>
<li> flush_blocked(清空黑名单)</li>
*/
Type: string;
/**
* 客户端真实IP存放的header字段名
*/
ClientIPField: string;
/**
* 封禁IP列表,单次操作数组最大长度支持200000
*/
BlockIPList?: Array<string>;
/**
* 过期时间,单位秒,默认值3600
*/
ExpireTime?: number;
/**
* 添加IP的策略,可取:fifo(如果黑名单容量已满,新加入黑名单的IP采用先进先出策略)
*/
AddStrategy?: string;
}
/**
* CreateKeys请求参数结构体
*/
export interface CreateKeysRequest {
/**
* <p>模型路由ID</p>
*/
ModelRouterId: string;
/**
* <p>需要绑定的预算信息,所有Key共用</p>
*/
BudgetId?: string;
/**
* <p>Key列表</p>
*/
Keys?: Array<InputKeyInfo>;
/**
* <p>批量创建Key的模式</p><p>枚举值:</p><ul><li>Generate: 平台生成Key</li><li>Import: 导入自带Key</li></ul><p>默认值:Generate</p>
*/
Mode?: string;
/**
* <p>限速信息,所有Key共用</p>
*/
RateLimitConfig?: RateLimitConfigForKey;
/**
* <p>标签。所有Key都会绑定该标签。</p>
*/
Tags?: Array<TagInfo>;
/**
* <p>需要关联的用户组ID</p>
*/
UserGroupId?: string;
}
/**
* CreateIntentRouter请求参数结构体
*/
export interface CreateIntentRouterRequest {
/**
* <p>模型路由实例ID。</p>
*/
ModelRouterId: string;
/**
* <p>路由名称,用作LiteLLM的model_name。</p><p>必须以"IntentRouter/"为前缀,后缀仅支持字母、数字、连字符和下划线,后缀长度1-128个字符。</p>
*/
RouteName: string;
/**
* <p>Tier配置列表。</p><p>每个Tier至少包含一个模型,模型名称必须是已关联到该实例的模型。</p>
*/
Tiers: Array<TierItem>;
/**
* <p>意图路由描述。</p>
*/
RouterDescribe?: string;
}
/**
* DeleteKeys返回参数结构体
*/
export interface DeleteKeysResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyDomain请求参数结构体
*/
export interface ModifyDomainRequest {
/**
* 负载均衡实例 ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。
*/
LoadBalancerId: string;
/**
* 负载均衡监听器 ID, 可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
*/
ListenerId: string;
/**
* 监听器下的某个旧域名, 可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 查询。
*/
Domain: string;
/**
* 新域名, 长度限制为:1-120。有三种使用格式:非正则表达式格式,通配符格式,正则表达式格式。非正则表达式格式只能使用字母、数字、‘-’、‘.’。通配符格式的使用 ‘*’ 只能在开头或者结尾。正则表达式以'~'开头。
*/
NewDomain: string;
}
/**
* Budget预算配置入参
*/
export interface BudgetConfigInput {
/**
* <p>预算刷新周期。</p><p>支持取值:</p><ul><li>1d:按天刷新</li><li>7d:按周刷新</li><li>30d:按月刷新</li></ul><p>不传时默认使用30d。同一个Budget下每种刷新周期最多配置一次。</p>
*/
BudgetDuration?: string;
/**
* <p>最大预算。</p><p>单位:credit。取值需大于0且不超过10000000000;不传时默认100000。</p>
*/
MaxBudget?: number;
}
/**
* Key 项
*/
export interface KeyItem {
/**
* Provider API Key
*/
ApiKey: string;
/**
* Key 标识名称
注意:此字段可能返回 null,表示取不到有效值。
*/
Name?: string;
}
/**
* 模型路由资源包退款价格
*/
export interface ModelRouterResourcePackageRefundPrice {
/**
* <p>模型路由资源包Id</p>
*/
ModelRouterPackageId?: string;
/**
* <p>可退还金额</p>
*/
Price?: number;
}
/**
* AssociateModelsToModelRouter请求参数结构体
*/
export interface AssociateModelsToModelRouterRequest {
/**
* <p>模型路由实例ID</p>
*/
ModelRouterId: string;
/**
* <p>需要关联的模型信息</p>
*/
Models?: Array<ModelRouterModel>;
}
/**
* CreateLoadBalancerSnatIps返回参数结构体
*/
export interface CreateLoadBalancerSnatIpsResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 负载均衡信息
*/
export interface ClassicalLoadBalancerInfo {
/**
* 后端实例ID
*/
InstanceId?: string;
/**
* 负载均衡实例ID列表
*/
LoadBalancerIds?: Array<string>;
}
/**
* DisassociateModelRouterGuardrails返回参数结构体
*/
export interface DisassociateModelRouterGuardrailsResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RegisterFunctionTargets返回参数结构体
*/
export interface RegisterFunctionTargetsResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteLoadBalancer请求参数结构体
*/
export interface DeleteLoadBalancerRequest {
/**
* 要删除的负载均衡实例 ID 数组,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取,数组大小最大支持20。
*/
LoadBalancerIds: Array<string>;
/**
* 是否强制删除clb。true表示强制删除,false表示不是强制删除,需要做拦截校验。
默认为false。
以下几种情况会默认拦截删除操作,如果触发情况1、2但确认强制删除则需要传强制校验参数ForceDelete为true。
1、删除后端绑定大于等于 20 个 RS 的实例时。
2、删除后端有 RS 且 5 分钟 内“出/入带宽”峰值取大 > 10Mbps 的实例时。
3、单地域内 5 分钟 内删除大于等于 30 个实例时。
*/
ForceDelete?: boolean;
}
/**
* 模型路由相关配额
*/
export interface ModelRouterQuota {
/**
* <p>配额名称</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
QuotaType?: string;
/**
* <p>资源ID</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
ResourceId?: string;
/**
* <p>配额上限</p><p>单位:个</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Limit?: number;
/**
* <p>已使用配额数量</p><p>单位:个</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Used?: number;
/**
* <p>剩余配额数量</p><p>单位:个</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Available?: number;
}
/**
* AddModelRewrite请求参数结构体
*/
export interface AddModelRewriteRequest {
/**
* <p>模型路由实例 ID。</p>
*/
ModelRouterId: string;
/**
* <p>源模型名(重写规则的 key)。</p><p>长度 1-255 字符;支持特殊值 <code>default</code> 表示兜底规则(命中所有未显式列出的源模型)。</p><p>不允许使用 <code>IntentRouter/</code> 前缀(大小写不敏感),即 IntentRouter 不能作为 source。</p>
*/
SourceModel: string;
/**
* <p>目标模型名(重写规则的 value)。</p><p>长度 1-255 字符;必须是已关联到该模型路由实例的模型(含 IntentRouter/* 也需先通过 AssociateModels 关联)。</p><p>不允许使用 <code>default</code>;不允许与 SourceModel 相同(大小写不敏感)。</p>
*/
TargetModel: string;
}
/**
* HTTP/HTTPS监听器下的转发规则绑定的后端服务信息
*/
export interface RuleTargets {
/**
* 转发规则的 ID
*/
LocationId?: string;
/**
* 转发规则的域名
*/
Domain?: string;
/**
* 转发规则的路径。
*/
Url?: string;
/**
* 后端服务的信息
*/
Targets?: Array<Backend>;
/**
* 后端云函数的信息
*/
FunctionTargets?: Array<FunctionTarget>;
}
/**
* 意图路由分层配置对象,包含分层名称和该分层下的模型列表。
*/
export interface IntentRouterTierItem {
/**
* <p>该分层下的模型显示名称列表。</p>
*/
Models?: Array<string>;
/**
* <p>Tier 标识。<br>枚举值:</p><ul><li>复杂度分层(4 个固定值,需全部包含):SIMPLE、MEDIUM、COMPLEX、REASONING</li><li>default: 默认</li><li>general_chat: 通用对话</li><li>transformation_rewrite: 转换与改写</li><li>knowledge_qa: 知识问答</li><li>summarization: 摘要</li><li>extraction_structuring: 抽取与结构化输出</li><li>content_generation: 内容生成</li><li>coding_technical: 编码与技术</li><li>data_math_analysis: 数据、数学与分析</li><li>reasoning_planning: 推理与规划</li><li>tool_agentic_workflow: 工具与智能体工作流</li></ul>
*/
TierName?: string;
}
/**
* BatchDeregisterTargets请求参数结构体
*/
export interface BatchDeregisterTargetsRequest {
/**
* 负载均衡ID。
*/
LoadBalancerId: string;
/**
* 解绑目标。
*/
Targets: Array<BatchTarget>;
}
/**
* ModifyListener返回参数结构体
*/
export interface ModifyListenerResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeTargetHealth返回参数结构体
*/
export interface DescribeTargetHealthResponse {
/**
* <p>负载均衡实例列表。</p>
*/
LoadBalancers?: Array<LoadBalancerHealth>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 模型路由 Guardrail 防护配置
*/
export interface GuardrailConfig {
/**
* <p>Guardrail 防护配置 ID。</p><p>DescribeModelRouterGuardrails 会返回该字段;DisassociateModelRouterGuardrails 和 ModifyModelRouterGuardrails 需要使用该字段定位要操作的防护配置。</p>
*/
GuardrailId?: string;
/**
* <p>Guardrail 防护类型。</p><p>枚举值:</p><ul><li>WAF:使用腾讯云 WAF LLM SDK 接入配置对模型路由请求进行安全防护。</li></ul><p>当前仅支持 WAF;AssociateModelRouterGuardrails 不传时默认为 WAF,ModifyModelRouterGuardrails 不传时沿用当前已关联 Guardrail 的 Type。</p>
*/
Type?: string;
/**
* <p>关联的腾讯云 WAF 实例 ID。</p><p>ModifyModelRouterGuardrails 在 Type 为 WAF 时必填。DescribeModelRouterGuardrails 返回。接口会校验该 WAF 实例存在且属于当前账号。</p>
*/
InstanceId?: string;
/**
* <p>WAF LLM SDK 接入服务 ID。</p><p>该字段对应 WAF LLM SDK 接入配置中的服务标识,用于指定模型路由请求要绑定的 WAF 防护配置。ModifyModelRouterGuardrails 在 Type 为 WAF 时必填。DescribeModelRouterGuardrails 返回。接口会校验该服务配置存在于指定的 WAF 实例下。</p>
*/
ServiceId?: string;
/**
* <p>最大检测对话轮数。</p><p>ModifyModelRouterGuardrails 选填;未传时沿用当前已关联 Guardrail 的 InputCheckDepth。DescribeModelRouterGuardrails 返回。若传入,取值必须为正整数。</p>
*/
InputCheckDepth?: number;
}
/**
* 独占集群信息
*/
export interface ClusterItem {
/**
* 集群唯一ID
*/
ClusterId: string;
/**
* 集群名称
*/
ClusterName?: string;
/**
* 集群所在可用区,如ap-guangzhou-1
注意:此字段可能返回 null,表示取不到有效值。
*/
Zone?: string;
}
/**
* ModifyModelRouterAttributes请求参数结构体
*/
export interface ModifyModelRouterAttributesRequest {
/**
* <p>模型路由ID</p>
*/
ModelRouterId: string;
/**
* <p>新的 HTTPS 证书ID,用于替换实例 HTTPS 服务端点当前绑定的证书。常用于证书到期前的更换场景。</p><p>使用限制:</p><ul><li>仅企业型(Enterprise)且服务端点协议为 HTTPS 的实例支持修改证书。</li><li>证书须为 SSL 证书控制台中状态为“已签发”(可用)且未过期的服务器证书(SVR 类型)。可在 <a href="https://console.cloud.tencent.com/ssl">SSL 证书控制台</a> 查看证书ID。</li><li>替换后新证书立即生效,过程中不会中断业务流量。</li><li>若传入的证书与当前绑定的证书相同,接口直接返回成功,不做任何变更。</li></ul><p>不传则证书保持不变。可通过 <code>DescribeModelRouterDetail</code> 接口的 <code>ServiceEndPoints.CertId</code> 字段查询当前绑定的证书。</p>
*/
CertId?: string;
/**
* <p>模型路由名称</p>
*/
ModelRouterName?: string;
/**
* <p>限速配置</p>
*/
RateLimitConfig?: RateLimitConfigForModelRouter;
/**
* <p>路由配置</p>
*/
RouterSetting?: RouterSettingWithFallBack;
}
/**
* 模型路由日志
*/
export interface ModelRouterLog {
/**
* <p>API Key的ID</p>
*/
KeyId?: string;
/**
* <p>模型</p>
*/
Model?: string;
/**
* <p>所属厂商</p>
*/
Provider?: string;
/**
* <p>请求状态</p><p>枚举值:</p><ul><li>failure: 失败</li><li>success: 成功</li></ul>
*/
Status?: string;
/**
* <p>最大重试次数</p>
*/
MaxRetries?: number;
/**
* <p>单次请求消耗的总Token数量</p>
*/
TotalTokens?: number;
/**
* <p>单次请求输入消耗的Token数量</p>
*/
InputTokens?: number;
/**
* <p>单次请求输出消耗的Token数量</p>
*/
OutputTokens?: number;
/**
* <p>请求耗时</p><p>单位:ms</p>
*/
RequestDuration?: number;
/**
* <p>请求IP</p>
*/
RequesterIp?: string;
/**
* <p>日志查询起始时间</p>
*/
StartTime?: string;
/**
* <p>日志查询结束时间</p>
*/
EndTime?: string;
}
/**
* DescribeLoadBalancers请求参数结构体
*/
export interface DescribeLoadBalancersRequest {
/**
* 负载均衡实例ID。实例ID数量上限为20个。
*/
LoadBalancerIds?: Array<string>;
/**
* 负载均衡实例的网络类型:
OPEN:公网属性, INTERNAL:内网属性。
*/
LoadBalancerType?: string;
/**
* 负载均衡实例的类型。1:通用的负载均衡实例,0:传统型负载均衡实例。如果不传此参数,则查询所有类型的负载均衡实例。
*/
Forward?: number;
/**
* 负载均衡实例的名称,支持模糊查询。
*/
LoadBalancerName?: string;
/**
* 腾讯云为负载均衡实例分配的域名,支持模糊查询。
*/
Domain?: string;
/**
* 负载均衡实例的 VIP 地址,支持多个。
*/
LoadBalancerVips?: Array<string>;
/**
* 负载均衡绑定的后端服务的外网 IP,只支持查询云服务器的公网 IP。
*/
BackendPublicIps?: Array<string>;
/**
* 负载均衡绑定的后端服务的内网 IP,只支持查询云服务器的内网 IP。
*/
BackendPrivateIps?: Array<string>;
/**
* 数据偏移量,默认为0。
*/
Offset?: number;
/**
* 返回负载均衡实例的数量,默认为20,最大值为100。
*/
Limit?: number;
/**
* 排序参数,支持以下字段:
- LoadBalancerName
- CreateTime
- Domain
- LoadBalancerType
默认为 CreateTime。
*/
OrderBy?: string;
/**
* 1:倒序,0:顺序,默认为1,按照创建时间倒序。
*/
OrderType?: number;
/**
* 模糊搜索字段,模糊匹配负载均衡实例的名称、域名、负载均衡实例的 VIP 地址,负载均衡实例ID。
*/
SearchKey?: string;
/**
* 负载均衡实例所属的项目 ID,可以通过[DescribeProject](https://cloud.tencent.com/document/api/651/78725)接口获取,不传默认所有项目。
*/
ProjectId?: number;
/**
* 负载均衡是否绑定后端服务,0:没有绑定后端服务,1:绑定后端服务,-1:查询全部。
*/
WithRs?: number;
/**
* 负载均衡实例所属私有网络唯一ID,如 vpc-bhqkbhdx,可以通过[DescribeVpcs](https://cloud.tencent.com/document/api/215/15778)接口获取。
查找基础网络类型的负载均衡可传入'0'。
*/
VpcId?: string;
/**
* 安全组ID,如 sg-m1cc****,可以通过接口[DescribeSecurityGroups](https://cloud.tencent.com/document/product/215/15808)获取。
*/
SecurityGroup?: string;
/**
* 主可用区ID,如 :"100001" (对应的是广州一区)。可通过[DescribeZones](https://cloud.tencent.com/document/product/213/15707)获取可用区列表。
*/
MasterZone?: string;
/**
* 每次请求的`Filters`的上限为10,`Filter.Values`的上限为100。<br/>`Filter.Name`和`Filter.Values`皆为必填项。详细的过滤条件如下:
- charge-type
按照【实例计费模式】进行过滤。实例计费模式例如:PREPAID。
类型:String
必选:否
可选项:PREPAID(预付费)、POSTPAID_BY_HOUR(后付费)
- internet-charge-type
按照【网络计费模式】进行过滤。网络计费模式例如:BANDWIDTH_PREPAID。
类型:String
必选:否
可选项:BANDWIDTH_PREPAID(预付费按带宽结算)、 TRAFFIC_POSTPAID_BY_HOUR(流量按小时后付费)、BANDWIDTH_POSTPAID_BY_HOUR(带宽按小时后付费)、BANDWIDTH_PACKAGE(带宽包用户)
- master-zone-id
按照【CLB主可用区ID】进行过滤。例如:100001(对应的是广州一区)。
类型:String
必选:否
获取方式:[DescribeZones](https://cloud.tencent.com/document/product/213/15707)
- tag-key
按照【CLB 标签的键】进行过滤,例如:tag-key。
类型:String
必选:否
获取方式:[DescribeTags](https://cloud.tencent.com/document/api/651/35316)
- tag:tag-key
按照【CLB标签键值】进行过滤,例如:tag-test。
类型:String
必选:否
获取方式:[DescribeTagKeys](https://cloud.tencent.com/document/api/651/35318)
- function-name
按照【后端绑定SCF云函数的函数名称】进行过滤,例如:helloworld-1744958255。
类型:String
必选:否
获取方式:[ListFunctions](https://cloud.tencent.com/document/api/583/18582)
- vip-isp
按照【CLB VIP的运营商类型】进行过滤,例如:BGP。
类型:String
必选:否
公网类型可选项:BGP(多线)、CMCC(中国移动)、CTCC(中国电信)、CUCC(中国联通)
内网类型可选项:INTERNAL(内网)
- sla-type
按照【CLB 的性能容量型规格】进行过滤,例如:clb.c4.xlarge。
类型:String
必选:否
可选项:clb.c2.medium(标准型)、clb.c3.small(高阶型1)、clb.c3.medium(高阶型2)、clb.c4.small(超强型1)、clb.c4.medium(超强型2)、clb.c4.large(超强型3)、clb.c4.xlarge(超强型4)
具体规格参数参考:
- exclusive
按照【独占实例】进行过滤。例如:1,代表筛选独占型实例。
类型:String
必选:否
可选项:0、1
*/
Filters?: Array<Filter>;
/**
* 选择返回的扩充字段,不指定时,扩充字段默认不返回。详细支持的扩充字段如下:
<li> TargetCount:绑定的后端服务数量</li>
*/
AdditionalFields?: Array<string>;
}
/**
* RemoveModelKey返回参数结构体
*/
export interface RemoveModelKeyResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RegenerateKeys请求参数结构体
*/
export interface RegenerateKeysRequest {
/**
* <p>模型路由实例ID</p>
*/
ModelRouterId: string;
/**
* <p>Key的ID列表</p>
*/
KeyIds?: Array<string>;
}
/**
* 路由FallBack配置
*/
export interface FallBackItem {
/**
* <p>默认回退模型列表</p>
*/
DefaultFallBackModels?: Array<string>;
}
/**
* BatchModifyTargetTag返回参数结构体
*/
export interface BatchModifyTargetTagResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteRewrite返回参数结构体
*/
export interface DeleteRewriteResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyTargetGroupAttribute请求参数结构体
*/
export interface ModifyTargetGroupAttributeRequest {
/**
* <p>目标组的ID。</p>
*/
TargetGroupId: string;
/**
* <p>目标组的新名称。命名规则:1-80 个英文字母、汉字等国际通用语言字符,数字,连接线“-”、下划线“_”等常见字符(禁止Unicode补充字符,如emoji表情、生僻汉字等)。</p>
*/
TargetGroupName?: string;
/**
* <p>目标组的新默认端口。全监听目标组不支持此参数。</p>
*/
Port?: number;
/**
* <p>调度算法,仅V2新版目标组,且后端转发协议为(HTTP|HTTPS|GRPC)时该参数有效。可选值:<br><ur><li>WRR:按权重轮询。</li><li>LEAST_CONN:最小连接数。</li><li>IP_HASH:按IP哈希。</li><li>默认为 WRR。</li><ur></p>
*/
ScheduleAlgorithm?: string;
/**
* <p>健康检查详情。</p>
*/
HealthCheck?: TargetGroupHealthCheck;
/**
* <p>后端服务默认权重, 其中:<ul><li>取值范围[0, 100]</li><li>设置该值后,添加后端服务到目标组时, 若后端服务不单独设置权重, 则使用这里的默认权重。 </li><li>v1目标组类型不支持设置Weight参数。</li> </ul></p>
*/
Weight?: number;
/**
* <p>是否开启长连接,此参数仅适用于HTTP/HTTPS目标组,true:关闭;false:开启, 默认关闭。</p>
*/
KeepaliveEnable?: boolean;
/**
* <p>会话保持时间,单位:秒。可选值:30~3600,默认 0,表示不开启。TCP/UDP目标组不支持该参数。</p>
*/
SessionExpireTime?: number;
/**
* <p>是否开启SNAT(源IP替换),True(开启)、False(关闭)。默认为关闭。注意:SnatEnable开启时会替换客户端源IP,此时<code>透传客户端源IP</code>选项关闭,反之亦然。</p>
*/
SnatEnable?: boolean;
}
/**
* 独占集群
*/
export interface ExclusiveCluster {
/**
* 4层独占集群列表
注意:此字段可能返回 null,表示取不到有效值。
*/
L4Clusters?: Array<ClusterItem>;
/**
* 7层独占集群列表
注意:此字段可能返回 null,表示取不到有效值。
*/
L7Clusters?: Array<ClusterItem>;
/**
* vpcgw集群
注意:此字段可能返回 null,表示取不到有效值。
*/
ClassicalCluster?: ClusterItem;
}
/**
* 查询单个实例详细信息
*/
export interface ModelRouterDetail {
/**
* <p>模型路由实例关联的Budget ID。</p><p>未关联Budget时返回空字符串。</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
BudgetId?: string;
/**
* <p>模型路由实例关联的Budget名称。</p><p>未关联Budget时返回空字符串。</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
BudgetName?: string;
/**
* <p>集群信息</p>
*/
ClusterInfo?: ClusterInfo;
/**
* <p>创建时间</p>
*/
CreatedTime?: string;
/**
* <p>模型路由实例按Budget刷新周期划分的Credit使用情况。</p><p>当关联Budget配置多个刷新周期时,按1d、7d、30d顺序返回各周期用量;未关联Budget时返回空数组。</p>
*/
CreditUsageSet?: Array<CreditUsage>;
/**
* <p>模型路由实例域名</p>
*/
Domain?: string;
/**
* <p>模型路由ID</p>
*/
ModelRouterId?: string;
/**
* <p>模型路由名称</p><p>默认值:-</p>
*/
ModelRouterName?: string;
/**
* <p>模型路由类型</p><p>枚举值:</p><ul><li>Shared: 共享型</li><li>Enterprise: 企业级</li></ul>
*/
ModelRouterType?: string;
/**
* <p>修改时间</p>
*/
ModifiedTime?: string;
/**
* <p>模型路由实例网络类型</p><p>枚举值:</p><ul><li>Internet: 公网</li><li>Intranet: 内网</li></ul>
*/
NetworkType?: string;
/**
* <p>模型路由限速信息</p>
*/
RateLimitConfig?: RateLimitConfigForModelRouter;
/**
* <p>模型路由的路由配置</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
RouterSetting?: RouterSettingWithFallBack;
/**
* <p>安全组ID列表</p>
*/
SecurityGroups?: Array<string>;
/**
* <p>模型路由实例的安全状态</p><p>枚举值:</p><ul><li>Normal: 正常</li><li>Banned: 已封禁</li><li>Frozen: 已冻结</li></ul>
*/
SecurityStatus?: string;
/**
* <p>模型路由网络配置列表</p>
*/
ServiceEndPoints?: Array<ServiceEndPoints>;
/**
* <p>模型路由实例状态</p><p>枚举值:</p><ul><li>Active: 运行中</li><li>Provisioning: 创建中</li><li>Configuring: 变配中</li></ul>
*/
Status?: string;
/**
* <p>模型路由实例所属子网的ID</p>
*/
SubnetId?: string;
/**
* <p>标签</p>
*/
Tags?: Array<TagInfo>;
/**
* <p>模型路由实例的计费状态</p><p>枚举值:</p><ul><li>Normal: 正常</li><li>Isolated: 已隔离</li></ul>
*/
TradeStatus?: string;
/**
* <p>模型路由实例VIP</p>
*/
Vip?: string;
/**
* <p>模型路由实例所属VPC的ID</p>
*/
VpcId?: string;
}
/**
* DescribeLoadBalancerListByCertId请求参数结构体
*/
export interface DescribeLoadBalancerListByCertIdRequest {
/**
* 服务端证书的ID,或客户端证书的ID。可以通过 [DescribeCertificate](https://cloud.tencent.com/document/api/400/41674) 接口查询。
数组最大长度为20。
*/
CertIds: Array<string>;
}
/**
* CreateModelRouterResourcePackage返回参数结构体
*/
export interface CreateModelRouterResourcePackageResponse {
/**
* <p>模型路由资源包Id</p>
*/
ModelRouterResourcePackageIds?: Array<string>;
/**
* <p>订单号</p>
*/
DealName?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RegenerateKeys返回参数结构体
*/
export interface RegenerateKeysResponse {
/**
* <p>重新生成失败的Key的ID列表</p>
*/
FailedKeyIds?: Array<string>;
/**
* <p>重新生成后的Key的信息</p>
*/
RegeneratedKeys?: Array<RegeneratedKey>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeClassicalLBListeners返回参数结构体
*/
export interface DescribeClassicalLBListenersResponse {
/**
* 监听器列表。
*/
Listeners?: Array<ClassicalListener>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeModelKeys请求参数结构体
*/
export interface DescribeModelKeysRequest {
/**
* <p>接入类型过滤:PublicBYOK/PublicCustom/PrivateCustom</p>
*/
AccessType?: string;
/**
* <p>过滤条件</p>
*/
Filters?: Array<Filter>;
/**
* <p>返回数量限制</p>
*/
Limit?: number;
/**
* <p>翻页启始索引</p>
*/
Offset?: number;
/**
* <p>服务提供商ID</p>
*/
ServiceProviderIds?: Array<string>;
}
/**
* ModelAlias 积分系数配置
*/
export interface Coefficient {
/**
* <p>缓存命中输入积分系数。</p><p>用于 provider prompt cache 命中的输入 token。</p><p>取值范围:[0, 5000]</p><p>默认值:3</p>
*/
InputCachedCoefficient?: number;
/**
* <p>输入积分系数。</p><p>取值范围:[1, 5000]</p><p>默认值:25</p>
*/
InputCoefficient?: number;
/**
* <p>输出积分系数。</p><p>取值范围:[1, 5000]</p><p>默认值:100</p>
*/
OutputCoefficient?: number;
}
/**
* DescribeAssociatedModelAvailability请求参数结构体
*/
export interface DescribeAssociatedModelAvailabilityRequest {
/**
* <p>模型路由ID</p>
*/
ModelRouterId?: string;
/**
* <p>模型列表</p>
*/
Models?: Array<string>;
}
/**
* DescribeBlockIPTask请求参数结构体
*/
export interface DescribeBlockIPTaskRequest {
/**
* ModifyBlockIPList 接口返回的异步任务的ID。
*/
TaskId: string;
}
/**
* 运营商类型信息
*/
export interface TypeInfo {
/**
* 运营商类型
*/
Type?: string;
/**
* 规格可用性
*/
SpecAvailabilitySet?: Array<SpecAvailability>;
}
/**
* OAuth配置信息。
*/
export interface OAuth {
/**
* 开启或关闭鉴权。
True: 开启;
False: 关闭
默认为关闭。
*/
OAuthEnable?: boolean;
/**
* IAP全部故障后,拒绝请求还是放行。
BYPASS: 通过
REJECT: 拒绝
默认为 BYPASS
*/
OAuthFailureStatus?: string;
}
/**
* DescribeClassicalLBTargets返回参数结构体
*/
export interface DescribeClassicalLBTargetsResponse {
/**
* 后端服务列表。
*/
Targets?: Array<ClassicalTarget>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteListener返回参数结构体
*/
export interface DeleteListenerResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyModelRouterAttributes返回参数结构体
*/
export interface ModifyModelRouterAttributesResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* InquiryPriceRenewLoadBalancer请求参数结构体
*/
export interface InquiryPriceRenewLoadBalancerRequest {
/**
* 负载均衡实例 ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459) 接口查询。
*/
LoadBalancerId: string;
/**
* 续费周期
*/
LoadBalancerChargePrepaid: LBChargePrepaid;
}
/**
* 网络计费模式,最大出带宽
*/
export interface InternetAccessible {
/**
* TRAFFIC_POSTPAID_BY_HOUR 按流量按小时后计费 ; BANDWIDTH_POSTPAID_BY_HOUR 按带宽按小时后计费,国际站用户不支持该计费模式; BANDWIDTH_PACKAGE 按带宽包计费;BANDWIDTH_PREPAID按带宽预付费。
*/
InternetChargeType?: string;
/**
* 最大出带宽,单位Mbps,仅对公网属性的共享型、性能容量型和独占型 CLB 实例、以及内网属性的性能容量型 CLB 实例生效。
- 对于公网属性的共享型和独占型 CLB 实例,最大出带宽的范围为1Mbps-2048Mbps。
- 对于公网属性和内网属性的性能容量型 CLB实例,最大出带宽的范围为1Mbps-61440Mbps。
(调用CreateLoadBalancer创建LB时不指定此参数则设置为默认值10Mbps。此上限可调整)
*/
InternetMaxBandwidthOut?: number;
/**
* 带宽包的类型,如 BGP(多线)。
类型如下:
SINGLEISP: 单线
BGP: 多线
HIGH_QUALITY_BGP: 精品BGP共享带宽包
SINGLEISP_CMCC: 中国移动共享带宽包
SINGLEISP_CTCC: 中国电信共享带宽包
SINGLEISP_CUCC: 中国联通共享带宽包
注意:此字段可能返回 null,表示取不到有效值。
*/
BandwidthpkgSubType?: string;
}
/**
* DeleteTargetGroups请求参数结构体
*/
export interface DeleteTargetGroupsRequest {
/**
* 目标组的ID数组,单次最多支持删除20个。
*/
TargetGroupIds: Array<string>;
}
/**
* SetLoadBalancerStartStatus请求参数结构体
*/
export interface SetLoadBalancerStartStatusRequest {
/**
* 操作类型。Start:启动实例,Stop:停止实例。
*/
OperationType: string;
/**
* 负载均衡实例ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459) 接口查询。
*/
LoadBalancerId: string;
/**
* 监听器ID。如果该字段为空,则表示操作负载均衡实例,如果不为空,则表示操作监听器。
*/
ListenerIds?: Array<string>;
}
/**
* 目标组关联到的规则
*/
export interface AssociationItem {
/**
* 关联到的负载均衡ID
*/
LoadBalancerId?: string;
/**
* 关联到的监听器ID
*/
ListenerId?: string;
/**
* 关联到的转发规则ID
注意:此字段可能返回 null,表示取不到有效值。
*/
LocationId?: string;
/**
* 关联到的监听器协议类型,如HTTP,TCP,
*/
Protocol?: string;
/**
* 关联到的监听器端口
*/
Port?: number;
/**
* 关联到的转发规则域名
注意:此字段可能返回 null,表示取不到有效值。
*/
Domain?: string;
/**
* 关联到的转发规则URL
注意:此字段可能返回 null,表示取不到有效值。
*/
Url?: string;
/**
* 负载均衡名称
*/
LoadBalancerName?: string;
/**
* 监听器名称
*/
ListenerName?: string;
/**
* 关联目标组的权重, 该参数只有v2新版目标组生效。
*/
Weight?: number;
/**
* 高级路由规则ID
*/
RuleId?: string;
}
/**
* BYOK健康探测结果
*/
export interface ModelTestResult {
/**
* <p>模型</p>
*/
Model?: string;
/**
* <p>健康状况</p><p>枚举值:</p><ul><li>Success: 健康</li><li>Error: 不健康</li></ul>
*/
Status?: string;
/**
* <p>错误信息</p>
*/
ErrorInfo?: ProviderTestConnectionErrorInfo;
/**
* <p>探测请求</p>
*/
TestConnectionRequest?: TestConnectionRequestInfo;
}
/**
* 负载均衡实例的信息
*/
export interface LoadBalancer {
/**
* 负载均衡实例 ID。
*/
LoadBalancerId?: string;
/**
* 负载均衡实例的名称。
*/
LoadBalancerName?: string;
/**
* 负载均衡实例的网络类型:
OPEN:公网属性, INTERNAL:内网属性;对于内网属性的负载均衡,可通过绑定EIP出公网,具体可参考EIP文档[绑定弹性公网IP](https://cloud.tencent.com/document/product/215/16700)。
*/
LoadBalancerType?: string;
/**
* 负载均衡类型标识,1:负载均衡,0:传统型负载均衡。
*/
Forward?: number;
/**
* 负载均衡实例的域名,仅公网传统型和域名型负载均衡实例才提供该字段。逐步下线中,建议用LoadBalancerDomain替代。
*/
Domain?: string;
/**
* 负载均衡实例的 VIP 列表。
*/
LoadBalancerVips?: Array<string>;
/**
* 负载均衡实例的状态,包括
0:创建中,1:正常运行。
*/
Status?: number;
/**
* 负载均衡实例的创建时间。
格式:YYYY-MM-DD HH:mm:ss
*/
CreateTime?: string;
/**
* 负载均衡实例的上次状态转换时间。
格式:YYYY-MM-DD HH:mm:ss
*/
StatusTime?: string;
/**
* 负载均衡实例所属的项目 ID, 0 表示默认项目。
*/
ProjectId?: number;
/**
* 私有网络的 ID
*/
VpcId?: string;
/**
* 高防 LB 的标识,1:高防负载均衡 0:非高防负载均衡。
*/
OpenBgp?: number;
/**
* 是否开启 SNAT,在 2016 年 12 月份之前的传统型内网负载均衡都是开启了 SNAT 的。
*/
Snat?: boolean;
/**
* 是否被隔离,0:表示未被隔离,1:表示被隔离。
*/
Isolation?: number;
/**
* 用户开启日志的信息,日志只有公网属性创建了 HTTP 、HTTPS 监听器的负载均衡才会有日志。
注意:此字段可能返回 null,表示取不到有效值。
* @deprecated
*/
Log?: string;
/**
* 负载均衡实例所在的子网(仅对内网VPC型LB有意义)
*/
SubnetId?: string;
/**
* 负载均衡实例的标签信息
*/
Tags?: Array<TagInfo>;
/**
* 负载均衡实例的安全组
*/
SecureGroups?: Array<string>;
/**
* 负载均衡实例绑定的后端设备的基本信息
*/
TargetRegionInfo?: TargetRegionInfo;
/**
* anycast负载均衡的发布域,对于非anycast的负载均衡,此字段返回为空字符串
*/
AnycastZone?: string;
/**
* IP版本,ipv4 | ipv6
*/
AddressIPVersion?: string;
/**
* 数值形式的私有网络 ID,可以通过[DescribeVpcs](https://cloud.tencent.com/document/product/215/15778)接口获取。
*/
NumericalVpcId?: number;
/**
* 负载均衡IP地址所属的运营商。
- BGP : BGP(多线)
- CMCC:中国移动单线
- CTCC:中国电信单线
- CUCC:中国联通单线
注意:此字段可能返回 null,表示取不到有效值。
*/
VipIsp?: string;
/**
* 主可用区
注意:此字段可能返回 null,表示取不到有效值。
*/
MasterZone?: ZoneInfo;
/**
* 备可用区
注意:此字段可能返回 null,表示取不到有效值。
*/
BackupZoneSet?: Array<ZoneInfo>;
/**
* 负载均衡实例被隔离的时间。
格式:YYYY-MM-DD HH:mm:ss
注意:此字段可能返回 null,表示取不到有效值。
*/
IsolatedTime?: string;
/**
* 负载均衡实例的过期时间,仅对预付费负载均衡生效。
格式:YYYY-MM-DD HH:mm:ss
注意:此字段可能返回 null,表示取不到有效值。
*/
ExpireTime?: string;
/**
* 负载均衡实例的计费类型,PREPAID:包年包月,POSTPAID_BY_HOUR:按量计费
注意:此字段可能返回 null,表示取不到有效值。
*/
ChargeType?: string;
/**
* 负载均衡实例的网络属性
注意:此字段可能返回 null,表示取不到有效值。
*/
NetworkAttributes?: InternetAccessible;
/**
* 负载均衡实例的预付费相关属性,仅在 ChargeType=PREPAID 时显示。
注意:此字段可能返回 null,表示取不到有效值。
*/
PrepaidAttributes?: LBChargePrepaid;