tencentcloud-sdk-nodejs

/** * DeleteRewrite请求参数结构体 */ export interface DeleteRewriteRequest { /** * 负载均衡实例ID。 */ LoadBalancerId: string; /** * 源监听器ID。 */ SourceListenerId: string; /** * 目标监听器ID。 */ TargetListenerId: string; /** * 转发规则之间的重定向关系。 */ RewriteInfos: Array<RewriteLocationMap>; } /** * DescribeTargetGroupList返回参数结构体 */ export interface DescribeTargetGroupListResponse { /** * 显示的结果数量。 */ TotalCount?: number; /** * 显示的目标组信息集合。 */ TargetGroupSet?: Array<TargetGroupInfo>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeQuota请求参数结构体 */ export declare type DescribeQuotaRequest = null; /** * DescribeTargetGroupList请求参数结构体 */ export interface DescribeTargetGroupListRequest { /** * 目标组ID数组。 */ TargetGroupIds?: Array<string>; /** * 过滤条件数组，支持TargetGroupVpcId和TargetGroupName。与TargetGroupIds互斥，优先使用目标组ID。 */ Filters?: Array<Filter>; /** * 显示的偏移起始量。 */ Offset?: number; /** * 显示条数限制，默认为20。 */ Limit?: number; } /** * BatchDeregisterTargets返回参数结构体 */ export interface BatchDeregisterTargetsResponse { /** * 解绑失败的监听器ID。 */ FailListenerIdSet?: Array<string>; /** * 解绑失败错误原因信息。注意：此字段可能返回 null，表示取不到有效值。 */ Message?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SetLoadBalancerSecurityGroups返回参数结构体 */ export interface SetLoadBalancerSecurityGroupsResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 七层规则对象 */ export interface RulesItems { /** * 规则id */ LocationId?: string; /** * 域名 */ Domain?: string; /** * uri */ Url?: string; /** * 绑定的后端对象 */ Targets?: Array<LbRsTargets>; } /** * 暂做保留，一般用户无需关注。 */ export interface ExtraInfo { /** * 是否开通VIP直通注意：此字段可能返回 null，表示取不到有效值。 */ ZhiTong?: boolean; /** * TgwGroup名称注意：此字段可能返回 null，表示取不到有效值。 */ TgwGroupName?: string; } /** * 传统型负载均衡监听器信息 */ export interface ClassicalListener { /** * 负载均衡监听器ID */ ListenerId?: string; /** * 负载均衡监听器端口 */ ListenerPort?: number; /** * 监听器后端转发端口 */ InstancePort?: number; /** * 监听器名称 */ ListenerName?: string; /** * 监听器协议类型 */ Protocol?: string; /** * 会话保持时间 */ SessionExpire?: number; /** * 是否开启了健康检查：1（开启）、0（关闭） */ HealthSwitch?: number; /** * 响应超时时间 */ TimeOut?: number; /** * 检查间隔 */ IntervalTime?: number; /** * 健康阈值 */ HealthNum?: number; /** * 不健康阈值 */ UnhealthNum?: number; /** * 传统型公网负载均衡监听器的请求均衡方法。空字符串或wrr 表示按权重轮询，ip_hash 表示根据访问的源 IP 进行一致性哈希方式来分发，least_conn表示按最小连接数。 */ HttpHash?: string; /** * 传统型公网负载均衡的 HTTP、HTTPS 监听器的健康检查返回码。具体可参考创建监听器中对该字段的解释 */ HttpCode?: number; /** * 传统型公网负载均衡的 HTTP、HTTPS 监听器的健康检查路径 */ HttpCheckPath?: string; /** * 传统型公网负载均衡的 HTTPS 监听器的认证方式 */ SSLMode?: string; /** * 传统型公网负载均衡的 HTTPS 监听器的服务端证书 ID */ CertId?: string; /** * 传统型公网负载均衡的 HTTPS 监听器的客户端证书 ID */ CertCaId?: string; /** * 监听器的状态，0 表示创建中，1 表示运行中 */ Status?: number; } /** * BatchModifyTargetWeight返回参数结构体 */ export interface BatchModifyTargetWeightResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SetSecurityGroupForLoadbalancers请求参数结构体 */ export interface SetSecurityGroupForLoadbalancersRequest { /** * 安全组ID，如 sg-12345678 */ SecurityGroup: string; /** * ADD 绑定安全组； DEL 解绑安全组 */ OperationType: string; /** * 负载均衡实例ID数组 */ LoadBalancerIds: Array<string>; } /** * CreateLoadBalancer请求参数结构体 */ export interface CreateLoadBalancerRequest { /** * 负载均衡实例的网络类型： OPEN：公网属性， INTERNAL：内网属性。 */ LoadBalancerType: string; /** * 负载均衡实例的类型。1：通用的负载均衡实例，目前只支持传入1。 */ Forward?: number; /** * 负载均衡实例的名称，只在创建一个实例的时候才会生效。规则：1-60 个英文、汉字、数字、连接线“-”或下划线“_”。注意：如果名称与系统中已有负载均衡实例的名称相同，则系统将会自动生成此次创建的负载均衡实例的名称。 */ LoadBalancerName?: string; /** * 负载均衡后端目标设备所属的网络 ID，如vpc-12345678，可以通过 [DescribeVpcs](https://cloud.tencent.com/document/product/215/15778) 接口获取。不填此参数则默认为DefaultVPC。创建内网负载均衡实例时，此参数必填。 */ VpcId?: string; /** * 在私有网络内购买内网负载均衡实例的情况下，必须指定子网 ID，内网负载均衡实例的 VIP 将从这个子网中产生。创建内网负载均衡实例时，此参数必填，创建公网IPv4负载均衡实例时，不支持指定该参数。 */ SubnetId?: string; /** * 负载均衡实例所属的项目 ID，可以通过 [DescribeProject](https://cloud.tencent.com/document/api/651/78725) 接口获取。不填此参数则视为默认项目。 */ ProjectId?: number; /** * 仅适用于公网负载均衡。IP版本，可取值：IPV4、IPV6、IPv6FullChain，不区分大小写，默认值 IPV4。说明：取值为IPV6表示为IPV6 NAT64版本；取值为IPv6FullChain，表示为IPv6版本。 */ AddressIPVersion?: string; /** * 创建负载均衡的个数，默认值 1。 */ Number?: number; /** * 仅适用于公网且IP版本为IPv4的负载均衡。设置跨可用区容灾时的主可用区ID，例如 100001 或 ap-guangzhou-1 注：主可用区是需要承载流量的可用区，备可用区默认不承载流量，主可用区不可用时才使用备可用区。目前仅广州、上海、南京、北京、成都、深圳金融、中国香港、首尔、法兰克福、新加坡地域的 IPv4 版本的 CLB 支持主备可用区。可通过 [DescribeResources](https://cloud.tencent.com/document/api/214/70213) 接口查询一个地域的主可用区的列表。【如果您需要体验该功能，请通过 [工单申请](https://console.cloud.tencent.com/workorder/category)】 */ MasterZoneId?: string; /** * 仅适用于公网且IP版本为IPv4的负载均衡。可用区ID，指定可用区以创建负载均衡实例。如：ap-guangzhou-1。 */ ZoneId?: string; /** * 网络计费模式，最大出带宽。仅对内网属性的性能容量型实例和公网属性的所有实例生效。 */ InternetAccessible?: InternetAccessible; /** * 仅适用于公网负载均衡。目前仅广州、上海、南京、济南、杭州、福州、北京、石家庄、武汉、长沙、成都、重庆地域支持静态单线 IP 线路类型，如需体验，请联系商务经理申请。申请通过后，即可选择中国移动（CMCC）、中国联通（CUCC）或中国电信（CTCC）的运营商类型，网络计费模式只能使用按带宽包计费(BANDWIDTH_PACKAGE)。如果不指定本参数，则默认使用BGP。可通过 [DescribeResources](https://cloud.tencent.com/document/api/214/70213) 接口查询一个地域所支持的Isp。 */ VipIsp?: string; /** * 购买负载均衡的同时，给负载均衡打上标签，最大支持20个标签键值对。 */ Tags?: Array<TagInfo>; /** * 指定VIP申请负载均衡。此参数选填，不填写此参数时自动分配VIP。IPv4和IPv6类型支持此参数，IPv6 NAT64类型不支持。注意：当指定VIP创建内网实例、或公网IPv6 BGP实例时，若VIP不属于指定VPC子网的网段内时，会创建失败；若VIP已被占用，也会创建失败。 */ Vip?: string; /** * 带宽包ID，指定此参数时，网络计费方式（InternetAccessible.InternetChargeType）只支持按带宽包计费（BANDWIDTH_PACKAGE），带宽包的属性即为其结算方式。非上移用户购买的 IPv6 负载均衡实例，且运营商类型非 BGP 时，不支持指定具体带宽包id。 */ BandwidthPackageId?: string; /** * 独占型实例信息。若创建独占型的内网负载均衡实例，则此参数必填。 */ ExclusiveCluster?: ExclusiveCluster; /** * 性能容量型规格。 <ul><li>若需要创建性能容量型实例，则此参数必填，取值范围：<ul><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></ul></li><li>若需要创建共享型实例，则无需填写此参数。</li></ul>如需了解规格详情，请参见[实例规格对比](https://cloud.tencent.com/document/product/214/84689)。 */ SlaType?: string; /** * 集群ID，集群标识，在需要配置公有云独占集群或本地专有集群时使用。公有云独占集群申请请[提交工单](https://console.cloud.tencent.com/workorder/category)，本地专有集群请参考[本地专有集群](https://cloud.tencent.com/document/product/1346)描述。 */ ClusterIds?: Array<string>; /** * 用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。 */ ClientToken?: string; /** * 是否支持绑定跨地域/跨Vpc绑定IP的功能。 */ SnatPro?: boolean; /** * 开启绑定跨地域/跨Vpc绑定IP的功能后，创建SnatIp。 */ SnatIps?: Array<SnatIp>; /** * Stgw独占集群的标签。 */ ClusterTag?: string; /** * 仅适用于公网且IP版本为IPv4的负载均衡。设置跨可用区容灾时的备可用区ID，例如 100001 或 ap-guangzhou-1 注：备可用区是主可用区故障后，需要承载流量的可用区。可通过 [DescribeResources](https://cloud.tencent.com/document/api/214/70213) 接口查询一个地域的主/备可用区的列表。【如果您需要体验该功能，请通过 [工单申请](https://console.cloud.tencent.com/workorder/category)】 */ SlaveZoneId?: string; /** * EIP 的唯一 ID，形如：eip-11112222，仅适用于内网负载均衡绑定EIP。 */ EipAddressId?: string; /** * Target是否放通来自CLB的流量。开启放通（true）：只验证CLB上的安全组；不开启放通（false）：需同时验证CLB和后端实例上的安全组。 */ LoadBalancerPassToTarget?: boolean; /** * 创建域名化负载均衡。 */ DynamicVip?: boolean; /** * 网络出口 */ Egress?: string; /** * 负载均衡实例的预付费相关属性 */ LBChargePrepaid?: LBChargePrepaid; /** * 负载均衡实例计费类型，取值：POSTPAID_BY_HOUR，PREPAID，默认是POSTPAID_BY_HOUR。 */ LBChargeType?: string; /** * 七层访问日志主题ID */ AccessLogTopicId?: string; } /** * DescribeLoadBalancerOverview返回参数结构体 */ export interface DescribeLoadBalancerOverviewResponse { /** * 负载均衡总数 */ TotalCount?: number; /** * 运行中的负载均衡数目 */ RunningCount?: number; /** * 隔离中的负载均衡数目 */ IsolationCount?: number; /** * 即将到期的负载均衡数目 */ WillExpireCount?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteRule请求参数结构体 */ export interface DeleteRuleRequest { /** * 负载均衡实例ID。 */ LoadBalancerId: string; /** * 负载均衡监听器ID。 */ ListenerId: string; /** * 要删除的转发规则的ID组成的数组。 */ LocationIds?: Array<string>; /** * 要删除的转发规则的域名，如果是多域名，可以指定多域名列表中的任意一个。 */ Domain?: string; /** * 要删除的转发规则的转发路径。 */ Url?: string; /** * 监听器下必须配置一个默认域名，当需要删除默认域名时，可以指定另一个域名作为新的默认域名，如果新的默认域名是多域名，可以指定多域名列表中的任意一个。 */ NewDefaultServerDomain?: string; } /** * CloneLoadBalancer请求参数结构体 */ export interface CloneLoadBalancerRequest { /** * 负载均衡ID。 */ LoadBalancerId: string; /** * 克隆出负载均衡实例的名称，规则：1-60 个英文、汉字、数字、连接线“-”或下划线“_”。注意：如果名称与系统中已有负载均衡实例的名称相同，则系统将会自动生成此次创建的负载均衡实例的名称。 */ LoadBalancerName?: string; /** * 负载均衡实例所属的项目 ID，可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。不传此参数则视为默认项目。 */ ProjectId?: number; /** * 仅适用于公网负载均衡。设置跨可用区容灾时的主可用区ID，例如 100001 或 ap-guangzhou-1 注：主可用区是需要承载流量的可用区，备可用区默认不承载流量，主可用区不可用时才使用备可用区，平台将为您自动选择最佳备可用区。可通过 [DescribeResources](https://cloud.tencent.com/document/api/214/70213) 接口查询一个地域的主可用区的列表。 */ MasterZoneId?: string; /** * 仅适用于公网负载均衡。设置跨可用区容灾时的备可用区ID，例如 100001 或 ap-guangzhou-1 注：备可用区是主可用区故障后，需要承载流量的可用区。可通过 [DescribeResources](https://cloud.tencent.com/document/api/214/70213) 接口查询一个地域的主/备可用区的列表。 */ SlaveZoneId?: string; /** * 仅适用于公网负载均衡。可用区ID，指定可用区以创建负载均衡实例。如：ap-guangzhou-1。不传则查询所有可用区的 CVM 实例。如需指定可用区，可调用查询可用区列表[DescribeZones](https://cloud.tencent.com/document/product/213/15707)接口查询。 */ ZoneId?: string; /** * 仅适用于公网负载均衡。负载均衡的网络计费模式。 */ InternetAccessible?: InternetAccessible; /** * 仅适用于公网负载均衡。目前仅广州、上海、南京、济南、杭州、福州、北京、石家庄、武汉、长沙、成都、重庆地域支持静态单线 IP 线路类型，如需体验，请联系商务经理申请。申请通过后，即可选择中国移动（CMCC）、中国联通（CUCC）或中国电信（CTCC）的运营商类型，网络计费模式只能使用按带宽包计费(BANDWIDTH_PACKAGE)。如果不指定本参数，则默认使用BGP。可通过 DescribeResources 接口查询一个地域所支持的Isp。 */ VipIsp?: string; /** * 指定Vip申请负载均衡。 */ Vip?: string; /** * 购买负载均衡同时，给负载均衡打上标签。 */ Tags?: Array<TagInfo>; /** * 独占集群信息。 */ ExclusiveCluster?: ExclusiveCluster; /** * 带宽包ID，指定此参数时，网络计费方式（InternetAccessible.InternetChargeType）只支持按带宽包计费（BANDWIDTH_PACKAGE）。 */ BandwidthPackageId?: string; /** * 是否支持绑定跨地域/跨Vpc绑定IP的功能。 */ SnatPro?: boolean; /** * 开启绑定跨地域/跨Vpc绑定IP的功能后，创建SnatIp。 */ SnatIps?: Array<SnatIp>; /** * 公网独占集群ID或者CDCId。 */ ClusterIds?: Array<string>; /** * 性能容量型规格。<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> */ SlaType?: string; /** * Stgw独占集群的标签。 */ ClusterTag?: string; /** * 仅适用于私有网络内网负载均衡。内网就近接入时，选择可用区下发。可调用[DescribeZones](https://cloud.tencent.com/document/product/213/15707)接口查询可用区列表。 */ Zones?: Array<string>; /** * EIP 的唯一 ID，形如：eip-11112222，仅适用于内网负载均衡绑定EIP。 */ EipAddressId?: string; } /** * DisassociateTargetGroups返回参数结构体 */ export interface DisassociateTargetGroupsResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 监听器上绑定的后端服务的信息 */ export interface ListenerBackend { /** * 监听器 ID */ ListenerId?: string; /** * 监听器的协议 */ Protocol?: string; /** * 监听器的端口 */ Port?: number; /** * 监听器下的规则信息（仅适用于HTTP/HTTPS监听器）注意：此字段可能返回 null，表示取不到有效值。 */ Rules?: Array<RuleTargets>; /** * 监听器上绑定的后端服务列表（仅适用于TCP/UDP/TCP_SSL监听器）注意：此字段可能返回 null，表示取不到有效值。 */ Targets?: Array<Backend>; /** * 若支持端口段，则为端口段结束端口；若不支持端口段，则为0 注意：此字段可能返回 null，表示取不到有效值。 */ EndPort?: number; } /** * SetLoadBalancerClsLog返回参数结构体 */ export interface SetLoadBalancerClsLogResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLoadBalancerTraffic返回参数结构体 */ export interface DescribeLoadBalancerTrafficResponse { /** * 按出带宽从高到低排序后的负载均衡信息。注意：此字段可能返回 null，表示取不到有效值。 */ LoadBalancerTraffic?: Array<LoadBalancerTraffic>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CLB监听器或规则绑定的多证书信息 */ export interface MultiCertInfo { /** * 认证类型，UNIDIRECTIONAL：单向认证，MUTUAL：双向认证 */ SSLMode: string; /** * 监听器或规则证书列表，单双向认证，多本服务端证书算法类型不能重复;若SSLMode为双向认证，证书列表必须包含一本ca证书。 */ CertList: Array<CertInfo>; /** * 双向认证时，是否开启客户端认证，ON:开启，OPTIONAL:自适应，默认ON */ SSLVerifyClient?: string; } /** * 修改节点标签的数据类型 */ export interface RsTagRule { /** * 负载均衡监听器 ID。 */ ListenerId: string; /** * 要修改标签的后端机器列表。 */ Targets: Array<Target>; /** * 转发规则的ID，七层规则时需要此参数，4层规则不需要。 */ LocationId?: string; /** * 后端服务修改后的标签。此参数的优先级低于前述[Target](https://cloud.tencent.com/document/api/214/30694#Target)中的Tag参数，即最终的标签以Target中的Tag参数值为准，仅当Target中的Weight参数为空时，才以RsTagRule中的Tag参数为准。 */ Tag?: string; } /** * ModifyRule请求参数结构体 */ export interface ModifyRuleRequest { /** * 负载均衡实例 ID。 */ LoadBalancerId: string; /** * 负载均衡监听器 ID。 */ ListenerId: string; /** * 要修改的转发规则的 ID。 */ LocationId: string; /** * 转发规则的新的转发路径，如不需修改Url，则不需提供此参数。 */ Url?: string; /** * 健康检查信息。 */ HealthCheck?: HealthCheck; /** * 规则的请求转发方式，可选值：WRR、LEAST_CONN、IP_HASH 分别表示按权重轮询、最小连接数、按IP哈希，默认为 WRR。 */ Scheduler?: string; /** * 会话保持时间。取值范围0或30-86400（单位：秒）。 */ SessionExpireTime?: number; /** * 负载均衡实例与后端服务之间的转发协议，默认HTTP，可取值：HTTP、HTTPS、GRPC。仅HTTPS监听器该参数有效。 */ ForwardType?: string; /** * TRPC被调服务器路由，ForwardType为TRPC时必填。目前暂未对外开放。 */ TrpcCallee?: string; /** * TRPC调用服务接口，ForwardType为TRPC时必填。目前暂未对外开放。 */ TrpcFunc?: string; /** * OAuth配置信息。 */ OAuth?: OAuth; } /** * DescribeCustomizedConfigList返回参数结构体 */ export interface DescribeCustomizedConfigListResponse { /** * 配置列表 */ ConfigList?: Array<ConfigListItem>; /** * 配置数目 */ TotalCount?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeBlockIPList返回参数结构体 */ export interface DescribeBlockIPListResponse { /** * 返回的IP的数量 */ BlockedIPCount?: number; /** * 获取用户真实IP的字段 */ ClientIPField?: string; /** * 加入了12360黑名单的IP列表 */ BlockedIPList?: Array<BlockedIP>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeRewrite请求参数结构体 */ export interface DescribeRewriteRequest { /** * 负载均衡实例ID。 */ LoadBalancerId: string; /** * 负载均衡监听器ID数组。 */ SourceListenerIds?: Array<string>; /** * 负载均衡转发规则的ID数组。 */ SourceLocationIds?: Array<string>; } /** * ModifyLoadBalancerAttributes返回参数结构体 */ export interface ModifyLoadBalancerAttributesResponse { /** * 切换负载均衡计费方式时，可用此参数查询切换任务是否成功。注意：此字段可能返回 null，表示取不到有效值。 */ DealName?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTargetGroupInstances请求参数结构体 */ export interface DescribeTargetGroupInstancesRequest { /** * 过滤条件，当前仅支持TargetGroupId，BindIP，InstanceId过滤。 */ Filters: Array<Filter>; /** * 显示数量限制，默认20。 */ Limit?: number; /** * 显示的偏移量，默认为0。 */ Offset?: number; } /** * DescribeIdleLoadBalancers返回参数结构体 */ export interface DescribeIdleLoadBalancersResponse { /** * 闲置实例列表注意：此字段可能返回 null，表示取不到有效值。 */ IdleLoadBalancers: Array<IdleLoadBalancer>; /** * 所有闲置实例数目 */ TotalCount: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 配置绑定关系 */ export interface BindItem { /** * 配置绑定的CLB ID */ LoadBalancerId: string; /** * 配置绑定的监听器ID 注意：此字段可能返回 null，表示取不到有效值。 */ ListenerId: string; /** * 配置绑定的域名注意：此字段可能返回 null，表示取不到有效值。 */ Domain: string; /** * 配置绑定的规则注意：此字段可能返回 null，表示取不到有效值。 */ LocationId?: 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。 */ OrderBy?: string; /** * 1：倒序，0：顺序，默认按照创建时间倒序。 */ OrderType?: number; /** * 搜索字段，模糊匹配名称、域名、VIP。 */ SearchKey?: string; /** * 负载均衡实例所属的项目 ID，可以通过 DescribeProject 接口获取。 */ ProjectId?: number; /** * 负载均衡是否绑定后端服务，0：没有绑定后端服务，1：绑定后端服务，-1：查询全部。 */ WithRs?: number; /** * 负载均衡实例所属私有网络唯一ID，如 vpc-bhqkbhdx，基础网络可传入'0'。 */ VpcId?: string; /** * 安全组ID，如 sg-m1cc****。 */ 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`皆为必填项。详细的过滤条件如下：<li> charge-type - String - 是否必填：否 - （过滤条件）按照 CLB 的实例计费模式过滤，包括"PREPAID","POSTPAID_BY_HOUR"。</li><li> internet-charge-type - String - 是否必填：否 - （过滤条件）按照 CLB 的网络计费模式过滤，包括"BANDWIDTH_PREPAID","TRAFFIC_POSTPAID_BY_HOUR","BANDWIDTH_POSTPAID_BY_HOUR","BANDWIDTH_PACKAGE"。</li><li> master-zone-id - String - 是否必填：否 - （过滤条件）按照 CLB 的主可用区ID过滤，如："100001" （对应的是广州一区）。</li><li> tag-key - String - 是否必填：否 - （过滤条件）按照 CLB 标签的键过滤。</li><li> tag:tag-key - String - 是否必填：否 - （过滤条件）按照CLB标签键值对进行过滤，tag-key使用具体的标签键进行替换。</li><li> function-name - String - 是否必填：否 - （过滤条件）按照 CLB 后端绑定的SCF云函数的函数名称过滤。</li><li> vip-isp - String - 是否必填：否 - （过滤条件）按照 CLB VIP的运营商类型过滤，如："BGP","INTERNAL","CMCC","CTCC","CUCC"等。</li><li> sla-type - String - 是否必填：否 - （过滤条件）按照 CLB 的性能容量型规格过滤，包括"clb.c1.small","clb.c2.medium","clb.c3.small","clb.c3.medium","clb.c4.small","clb.c4.medium","clb.c4.large","clb.c4.xlarge","others"。</li><li> exclusive - uint64 - 是否必填：否 - （过滤条件）按照独占实例进行过滤。</li> */ Filters?: Array<Filter>; /** * 选择返回的扩充字段，不指定时，扩充字段默认不返回。详细支持的扩充字段如下： <li> TargetCount：绑定的后端服务数量</li> */ AdditionalFields?: Array<string>; } /** * AddCustomizedConfig请求参数结构体 */ export interface AddCustomizedConfigRequest { /** * 配置名字 */ ConfigName: string; /** * 配置类型，取值范围["CLB", "SERVER", "LOCATION"]，分别表示CLB配置，server配置，location配置。 */ ConfigType: string; /** * 配置内容 */ ConfigContent: string; } /** * 传统型负载均衡的后端服务相关信息 */ export interface ClassicalTarget { /** * 后端服务的类型，可取值：CVM、ENI（即将支持） */ Type?: string; /** * 后端服务的唯一 ID，可通过 DescribeInstances 接口返回字段中的 unInstanceId 字段获取 */ InstanceId?: string; /** * 后端服务的转发权重，取值范围：[0, 100]，默认为 10。 */ Weight?: number; /** * 后端服务的外网 IP 注意：此字段可能返回 null，表示取不到有效值。 */ PublicIpAddresses?: Array<string>; /** * 后端服务的内网 IP 注意：此字段可能返回 null，表示取不到有效值。 */ PrivateIpAddresses?: Array<string>; /** * 后端服务的实例名称注意：此字段可能返回 null，表示取不到有效值。 */ InstanceName?: string; /** * 后端服务的状态 1：故障，2：运行中，3：创建中，4：已关机，5：已退还，6：退还中， 7：重启中，8：开机中，9：关机中，10：密码重置中，11：格式化中，12：镜像制作中，13：带宽设置中，14：重装系统中，19：升级中，21：热迁移中注意：此字段可能返回 null，表示取不到有效值。 */ RunFlag?: number; } /** * 反查监听器类型 */ export interface ListenerItem { /** * 监听器ID */ ListenerId?: string; /** * 监听器协议 */ Protocol?: string; /** * 监听器端口 */ Port?: number; /** * 绑定规则注意：此字段可能返回 null，表示取不到有效值。 */ Rules?: Array<RulesItems>; /** * 四层绑定对象注意：此字段可能返回 null，表示取不到有效值。 */ Targets?: Array<LbRsTargets>; /** * 端口段监听器的结束端口注意：此字段可能返回 null，表示取不到有效值。 */ EndPort?: number; } /** * 修改节点权重的数据类型 */ export interface RsWeightRule { /** * 负载均衡监听器 ID。 */ ListenerId: string; /** * 要修改权重的后端机器列表。 */ Targets: Array<Target>; /** * 转发规则的ID，七层规则时需要此参数，4层规则不需要。 */ LocationId?: string; /** * 目标规则的域名，提供LocationId参数时本参数不生效。 * @deprecated */ Domain?: string; /** * 目标规则的URL，提供LocationId参数时本参数不生效。 * @deprecated */ Url?: string; /** * 后端服务修改后的转发权重，取值范围：[0，100]。此参数的优先级低于前述[Target](https://cloud.tencent.com/document/api/214/30694#Target)中的Weight参数，即最终的权重值以Target中的Weight参数值为准，仅当Target中的Weight参数为空时，才以RsWeightRule中的Weight参数为准。 */ Weight?: number; } /** * 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; } /** * DeregisterTargetsFromClassicalLB请求参数结构体 */ export interface DeregisterTargetsFromClassicalLBRequest { /** * 负载均衡实例ID。 */ LoadBalancerId: string; /** * 后端服务的实例ID列表。 */ InstanceIds: Array<string>; } /** * InquiryPriceModifyLoadBalancer请求参数结构体 */ export interface InquiryPriceModifyLoadBalancerRequest { /** * 负载均衡实例ID */ LoadBalancerId: string; /** * 修改后的网络带宽信息 */ InternetAccessible: InternetAccessible; } /** * ModifyCustomizedConfig请求参数结构体 */ export interface ModifyCustomizedConfigRequest { /** * 配置名字 */ ConfigName: string; /** * 配置ID */ UconfigId: string; /** * 配置内容 */ ConfigContent: string; } /** * 监听器或者转发规则绑定的目标组基本信息 */ export interface BasicTargetGroupInfo { /** * 目标组ID */ TargetGroupId?: string; /** * 目标组名称 */ TargetGroupName?: string; /** * 权重 */ Weight?: number; } /** * ModifyTargetWeight返回参数结构体 */ export interface ModifyTargetWeightResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 可用区资源列表 */ export interface ZoneResource { /** * 主可用区，如"ap-guangzhou-1"。 */ MasterZone?: string; /** * 资源列表。注意：此字段可能返回 null，表示取不到有效值。 */ ResourceSet?: Array<Resource>; /** * 备可用区，如"ap-guangzhou-2"，单可用区时，备可用区为null。注意：此字段可能返回 null，表示取不到有效值。 */ SlaveZone?: string; /** * IP版本，如IPv4，IPv6，IPv6_Nat。 */ IPVersion?: string; /** * 可用区所属地域，如：ap-guangzhou */ ZoneRegion?: string; /** * 可用区是否是LocalZone可用区，如：false */ LocalZone?: boolean; /** * 可用区资源的类型，SHARED表示共享资源，EXCLUSIVE表示独占资源。 */ ZoneResourceType?: string; /** * 可用区是否是EdgeZone可用区，如：false */ EdgeZone?: boolean; /** * 网络出口注意：此字段可能返回 null，表示取不到有效值。 */ Egress?: string; } /** * AssociateTargetGroups请求参数结构体 */ export interface AssociateTargetGroupsRequest { /** * 绑定的关系数组。一次请求最多支持20个。 */ Associations: Array<TargetGroupAssociation>; } /** * DescribeTaskStatus请求参数结构体 */ export interface DescribeTaskStatusRequest { /** * 请求ID，即接口返回的 RequestId 参数。 */ TaskId?: string; /** * 订单ID。注意：参数TaskId和DealName必须传一个。 */ DealName?: string; } /** * 目标组实例 */ export interface TargetGroupInstance { /** * 目标组实例的内网IP */ BindIP: string; /** * 目标组实例的端口，全监听目标组不支持传此字段。 */ Port?: number; /** * 目标组实例的权重 v2目标组需要配置权重，调用CreateTargetGroup接口创建目标组时该参数与创建接口中的Weight参数必填其一。 */ Weight?: number; /** * 目标组实例的新端口，全监听目标组不支持传此字段。 */ NewPort?: number; } /** * DescribeClassicalLBByInstanceId返回参数结构体 */ export interface DescribeClassicalLBByInstanceIdResponse { /** * 负载均衡相关信息列表。 */ LoadBalancerInfoList: Array<ClassicalLoadBalancerInfo>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateRule返回参数结构体 */ export interface CreateRuleResponse { /** * 创建的转发规则的唯一标识数组。 */ LocationIds: Array<string>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 跨域2.0云联网下子机和网卡信息 */ export interface CrossTargets { /** * 本地私有网络ID，即负载均衡的VpcId。 */ LocalVpcId?: string; /** * 子机或网卡所属的私有网络ID。 */ VpcId?: string; /** * 子机或网卡的IP地址 */ IP?: string; /** * 子机或网卡所属的私有网络名称。 */ VpcName?: string; /** * 子机的网卡ID。 */ EniId?: string; /** * 子机实例ID。注意：此字段可能返回 null，表示取不到有效值。 */ InstanceId?: string; /** * 子机实例名称。注意：此字段可能返回 null，表示取不到有效值。 */ InstanceName?: string; /** * 子机或者网卡所属的地域。 */ Region?: string; } /** * 一条转发规则的健康检查状态 */ export interface RuleHealth { /** * 转发规则ID */ LocationId?: string; /** * 转发规则的域名注意：此字段可能返回 null，表示取不到有效值。 */ Domain?: string; /** * 转发规则的Url 注意：此字段可能返回 null，表示取不到有效值。 */ Url?: string; /** * 本规则上绑定的后端服务的健康检查状态注意：此字段可能返回 null，表示取不到有效值。 */ Targets?: Array<TargetHealth>; } /** * DescribeExclusiveClusters返回参数结构体 */ export interface DescribeExclusiveClustersResponse { /** * 集群列表。 */ ClusterSet?: Array<Cluster>; /** * 集群总数量。 */ TotalCount?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyDomain请求参数结构体 */ export interface ModifyDomainRequest { /** * 负载均衡实例 ID。 */ LoadBalancerId: string; /** * 负载均衡监听器 ID。 */ ListenerId: string; /** * 监听器下的某个旧域名。 */ Domain: string; /** * 新域名，长度限制为：1-120。有三种使用格式：非正则表达式格式，通配符格式，正则表达式格式。非正则表达式格式只能使用字母、数字、‘-’、‘.’。通配符格式的使用 ‘*’ 只能在开头或者结尾。正则表达式以'~'开头。 */ NewDomain: string; } /** * DisassociateCustomizedConfig返回参数结构体 */ export interface DisassociateCustomizedConfigResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * BatchModifyTargetTag请求参数结构体 */ export interface BatchModifyTargetTagRequest { /** * 负载均衡实例 ID。 */ LoadBalancerId: string; /** * 要批量修改标签的列表。 */ ModifyList: Array<RsTagRule>; } /** * RegisterTargetGroupInstances返回参数结构体 */ export interface RegisterTargetGroupInstancesResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 传统型负载均衡的后端信息 */ export interface ClassicalTargetInfo { /** * 后端实例ID */ InstanceId: string; /** * 权重，取值范围 [0, 100] */ Weight?: number; } /** * DescribeTargets请求参数结构体 */ export interface DescribeTargetsRequest { /** * 负载均衡实例 ID。 */ LoadBalancerId: string; /** * 监听器 ID 列表。ID 数量上限为20个。 */ ListenerIds?: Array<string>; /** * 监听器协议类型。 */ Protocol?: string; /** * 监听器端口。 */ Port?: number; /** * 查询负载均衡绑定的后端服务列表，过滤条件如下： <li> location-id - String - 是否必填：否 - （过滤条件）按照规则ID 过滤，如："loc-12345678"。</li> <li> private-ip-address - String - 是否必填：否 - （过滤条件）按照后端服务内网IP 过滤，如："172.16.1.1"。</li> <li> tag - String - 是否必填：否 - （过滤条件）按照标签过滤，如："tag-test"。</li> */ Filters?: Array<Filter>; } /** * 可用区相关信息 */ export interface ZoneInfo { /** * 可用区数值形式的唯一ID，如：100001 注意：此字段可能返回 null，表示取不到有效值。 */ ZoneId?: number; /** * 可用区字符串形式的唯一ID，如：ap-guangzhou-1 注意：此字段可能返回 null，表示取不到有效值。 */ Zone?: string; /** * 可用区名称，如：广州一区注意：此字段可能返回 null，表示取不到有效值。 */ ZoneName?: string; /** * 可用区所属地域，如：ap-guangzhou 注意：此字段可能返回 null，表示取不到有效值。 */ ZoneRegion?: string; /** * 可用区是否是LocalZone可用区，如：false 注意：此字段可能返回 null，表示取不到有效值。 */ LocalZone?: boolean; /** * 可用区是否是EdgeZone可用区，如：false 注意：此字段可能返回 null，表示取不到有效值。 */ EdgeZone?: boolean; } /** * RegisterTargetsWithClassicalLB返回参数结构体 */ export interface RegisterTargetsWithClassicalLBResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTargetGroups返回参数结构体 */ export interface DescribeTargetGroupsResponse { /** * 显示的结果数量。 */ TotalCount?: number; /** * 显示的目标组信息集合。 */ TargetGroupSet?: Array<TargetGroupInfo>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 负载均衡实例的健康检查状态 */ export interface LoadBalancerHealth { /** * 负载均衡实例ID */ LoadBalancerId?: string; /** * 负载均衡实例名称注意：此字段可能返回 null，表示取不到有效值。 */ LoadBalancerName?: string; /** * 监听器列表注意：此字段可能返回 null，表示取不到有效值。 */ Listeners?: Array<ListenerHealth>; } /** * InquiryPriceCreateLoadBalancer请求参数结构体 */ export interface InquiryPriceCreateLoadBalancerRequest { /** * 询价的负载均衡类型，OPEN为公网类型，INTERNAL为内网类型 */ LoadBalancerType: string; /** * 询价的收费类型，POSTPAID为按量计费，"PREPAID"为预付费包年包月 */ LoadBalancerChargeType: string; /** * 询价的收费周期。（仅包年包月支持该参数） */ LoadBalancerChargePrepaid?: LBChargePrepaid; /** * 询价的网络计费方式 */ InternetAccessible?: InternetAccessible; /** * 询价的负载均衡实例个数，默认为1 */ GoodsNum?: number; /** * 指定可用区询价。如：ap-guangzhou-1 */ ZoneId?: string; /** * 包年包月询价时传性能容量型规格，如：<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> 按量付费询价时传SLA */ SlaType?: string; /** * IP版本，可取值：IPV4、IPV6、IPv6FullChain，不区分大小写，默认值 IPV4。说明：取值为IPV6表示为IPV6 NAT64版本；取值为IPv6FullChain，表示为IPv6版本。 */ AddressIPVersion?: string; /** * 仅适用于公网负载均衡。目前仅广州、上海、南京、济南、杭州、福州、北京、石家庄、武汉、长沙、成都、重庆地域支持静态单线 IP 线路类型，如需体验，请联系商务经理申请。申请通过后，即可选择中国移动（CMCC）、中国联通（CUCC）或中国电信（CTCC）的运营商类型，网络计费模式只能使用按带宽包计费(BANDWIDTH_PACKAGE)。如果不指定本参数，则默认使用BGP。可通过 DescribeResources 接口查询一个地域所支持的Isp。 */ VipIsp?: string; } /** * ModifyFunctionTargets返回参数结构体 */ export interface ModifyFunctionTargetsResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteLoadBalancerListeners请求参数结构体 */ export interface DeleteLoadBalancerListenersRequest { /** * 负载均衡实例ID。 */ LoadBalancerId: string; /** * 指定删除的监听器ID数组，最大为20个。若不填则删除负载均衡的所有监听器。 */ ListenerIds?: Array<string>; } /** * 加入了12306黑名单的IP */ export interface BlockedIP { /** * 黑名单IP */ IP?: string; /** * 加入黑名单的时间 */ CreateTime?: string; /** * 过期时间 */ ExpireTime?: string; } /** * ModifyRule返回参数结构体 */ export interface ModifyRuleResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeClassicalLBTargets请求参数结构体 */ export interface DescribeClassicalLBTargetsRequest { /** * 负载均衡实例 ID。 */ LoadBalancerId: string; } /** * InquiryPriceRenewLoadBalancer返回参数结构体 */ export interface InquiryPriceRenewLoadBalancerResponse { /** * 表示续费价格 */ Price?: Price; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeregisterFunctionTargets返回参数结构体 */ export interface DeregisterFunctionTargetsResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeCustomizedConfigList请求参数结构体 */ export interface DescribeCustomizedConfigListRequest { /** * 配置类型:CLB 负载均衡维度。 SERVER 域名维度。 LOCATION 规则维度。 */ ConfigType: string; /** * 拉取页偏移，默认值0 */ Offset?: number; /** * 拉取数目，默认值20 */ Limit?: number; /** * 拉取指定配置名字，模糊匹配。 */ ConfigName?: string; /** * 配置ID */ UconfigIds?: Array<string>; /** * 过滤条件如下： <li> loadbalancer-id - String - 是否必填：否 - （过滤条件）按照负载均衡ID 过滤，如："lb-12345678"。</li> <li> vip - String - 是否必填：否 - （过滤条件）按照负载均衡Vip 过滤，如："1.1.1.1","2204::22:3"。</li> */ Filters?: Array<Filter>; } /** * 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>; } /** * 闲置实例。 */ export interface IdleLoadBalancer { /** * 负载均衡ID */ LoadBalancerId: string; /** * 负载均衡名字 */ LoadBalancerName: string; /** * 负载均衡所在地域 */ Region: string; /** * 负载均衡的vip */ Vip: string; /** * 闲置原因。NO_RULES：没有规则，NO_RS：有规则没有绑定子机。 */ IdleReason: string; /** * 负载均衡实例的状态，包括 0：创建中，1：正常运行。 */ Status: number; /** * 负载均衡类型标识，1：负载均衡，0：传统型负载均衡。 */ Forward: number; /** * 负载均衡域名注意：此字段可能返回 null，表示取不到有效值。 */ Domain: string; } /** * DescribeCrossTargets返回参数结构体 */ export interface DescribeCrossTargetsResponse { /** * 后端服务列表总数。 */ TotalCount?: number; /** * 后端服务列表。 */ CrossTargetSet?: Array<CrossTargets>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SCF云函数（Serverless Cloud Function）相关信息。 */ export interface FunctionInfo { /** * 函数命名空间 */ FunctionNamespace: string; /** * 函数名称 */ FunctionName: string; /** * 函数的版本名称或别名 */ FunctionQualifier: string; /** * 标识 FunctionQualifier 参数的类型，可取值： VERSION（版本）、ALIAS（别名）注意：此字段可能返回 null，表示取不到有效值。 */ FunctionQualifierType?: string; } /** * ModifyCustomizedConfig返回参数结构体 */ export interface ModifyCustomizedConfigResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLoadBalancerListByCertId返回参数结构体 */ export interface DescribeLoadBalancerListByCertIdResponse { /** * 证书ID，以及与该证书ID关联的负载均衡实例列表 */ CertSet: Array<CertIdRelatedWithLoadBalancers>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyTargetGroupInstancesWeight返回参数结构体 */ export interface ModifyTargetGroupInstancesWeightResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTargetGroups请求参数结构体 */ export interface DescribeTargetGroupsRequest { /** * 目标组ID，与Filters互斥。 */ TargetGroupIds?: Array<string>; /** * 显示条数限制，默认为20。 */ Limit?: number; /** * 显示的偏移起始量。 */ Offset?: number; /** * 过滤条件数组，与TargetGroupIds互斥，支持TargetGroupVpcId和TargetGroupName。 */ Filters?: Array<Filter>; } /** * DescribeTaskStatus返回参数结构体 */ export interface DescribeTaskStatusResponse { /** * 任务的当前状态。 0：成功，1：失败，2：进行中。 */ Status?: number; /** * 由负载均衡实例唯一 ID 组成的数组。注意：此字段可能返回 null，表示取不到有效值。 */ LoadBalancerIds?: Array<string>; /** * 辅助描述信息，如失败原因等。注意：此字段可能返回 null，表示取不到有效值。 */ Message?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * BatchRegisterTargets返回参数结构体 */ export interface BatchRegisterTargetsResponse { /** * 绑定失败的监听器ID，如为空表示全部绑定成功。 */ FailListenerIdSet?: Array<string>; /** * 绑定失败错误原因信息。 */ Message?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyLoadBalancerAttributes请求参数结构体 */ export interface ModifyLoadBalancerAttributesRequest { /** * 负载均衡的唯一ID */ LoadBalancerId: string; /** * 负载均衡实例名称 */ LoadBalancerName?: string; /** * 设置负载均衡跨地域绑定1.0的后端服务信息 */ TargetRegionInfo?: TargetRegionInfo; /** * 网络计费相关参数 */ InternetChargeInfo?: InternetAccessible; /** * Target是否放通来自CLB的流量。开启放通（true）：只验证CLB上的安全组；不开启放通（false）：需同时验证CLB和后端实例上的安全组。 */ LoadBalancerPassToTarget?: boolean; /** * 是否开启跨地域绑定2.0功能 */ SnatPro?: boolean; /** * 是否开启删除保护 */ DeleteProtect?: boolean; /** * 将负载均衡二级域名由mycloud.com改为tencentclb.com，子域名也会变换。修改后mycloud.com域名将失效。 */ ModifyClassicDomain?: boolean; } /** * InquiryPriceModifyLoadBalancer返回参数结构体 */ export interface InquiryPriceModifyLoadBalancerResponse { /** * 描述价格信息 */ Price?: Price; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLBListeners请求参数结构体 */ export interface DescribeLBListenersRequest { /** * 需要查询的内网ip列表 */ Backends: Array<LbRsItem>; } /** * 升级为性能容量型参数 */ export interface SlaUpdateParam { /** * lb的字符串ID */ LoadBalancerId: string; /** * 性能容量型规格，取值范围： <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>如需了解规格详情，请参见[实例规格对比](https://cloud.tencent.com/document/product/214/84689) */ SlaType: string; } /** * 转发目标，即绑定在负载均衡上的后端服务 */ export interface Target { /** * 后端服务的监听端口。注意：绑定CVM（云服务器）或ENI（弹性网卡）时必传此参数注意：此字段可能返回 null，表示取不到有效值。 */ Port: number; /** * 后端服务的类型，可取：CVM（云服务器）、ENI（弹性网卡）；作为入参时，目前本参数暂不生效。注意：此字段可能返回 null，表示取不到有效值。 */ Type?: string; /** * 绑定CVM时需要传入此参数，代表CVM的唯一 ID，可通过 DescribeInstances 接口返回字段中的 InstanceId 字段获取。表示绑定主网卡主IPv4地址；以下场景都不支持指定InstanceId：绑定非CVM，绑定CVM上的辅助网卡IP，通过跨域2.0绑定CVM，以及绑定CVM的IPv6地址等。注意：参数 InstanceId、EniIp 有且只能传入其中一个参数。注意：此字段可能返回 null，表示取不到有效值。 */ InstanceId?: string; /** * 后端服务修改后的转发权重，取值范围：[0, 100]，默认为 10。此参数的优先级高于[RsWeightRule](https://cloud.tencent.com/document/api/214/30694#RsWeightRule)中的Weight参数，即最终的权重值以此Weight参数值为准，仅当此Weight参数为空时，才以RsWeightRule中的Weight参数为准。 */ Weight?: number; /** * 绑定IP时需要传入此参数，支持弹性网卡的IP和其他内网IP，如果是弹性网卡则必须先绑定至CVM，然后才能绑定到负载均衡实例。注意：参数 InstanceId、EniIp 有且只能传入其中一个参数。如果绑定双栈IPV6子机，则必须传该参数。如果是跨地域绑定，则必须传该参数，不支持传InstanceId参数。注意：此字段可能返回 null，表示取不到有效值。 */ EniIp?: string; /** * 标签。注意：此字段可能返回 null，表示取不到有效值。 */ Tag?: string; } /** * DescribeLoadBalancerTraffic请求参数结构体 */ export interface DescribeLoadBalancerTrafficRequest { /** * 负载均衡所在地域，不传默认返回所有地域负载均衡。 */ LoadBalancerRegion?: string; } /** * DescribeBlockIPList请求参数结构体 */ export interface DescribeBlockIPListRequest { /** * 负载均衡实例 ID。 */ LoadBalancerId: string; /** * 数据偏移量，默认为 0。 */ Offset?: number; /** * 返回IP的最大个数，默认为 100000。 */ Limit?: number; } /** * MigrateClassicalLoadBalancers返回参数结构体 */ export interface MigrateClassicalLoadBalancersResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 证书ID，以及与该证书ID关联的负载均衡实例列表 */ export interface CertIdRelatedWithLoadBalancers { /** * 证书ID */ CertId?: string; /** * 与证书关联的负载均衡实例列表注意：此字段可能返回 null，表示取不到有效值。 */ LoadBalancers?: Array<LoadBalancer>; } /** * 描述了单项的价格信息 */ export interface ItemPrice { /** * 后付费单价，单位：元。注意：此字段可能返回 null，表示取不到有效值。 */ UnitPrice: number; /** * 后续计价单元，可取值范围： HOUR：表示计价单元是按每小时来计算。当前涉及该计价单元的场景有：实例按小时后付费（POSTPAID_BY_HOUR）、带宽按小时后付费（BANDWIDTH_POSTPAID_BY_HOUR）； GB：表示计价单元是按每GB来计算。当前涉及该计价单元的场景有：流量按小时后付费（TRAFFIC_POSTPAID_BY_HOUR）。注意：此字段可能返回 null，表示取不到有效值。 */ ChargeUnit: string; /** * 预支费用的原价，单位：元。注意：此字段可能返回 null，表示取不到有效值。 */ OriginalPrice: number; /** * 预支费用的折扣价，单位：元。注意：此字段可能返回 null，表示取不到有效值。 */ DiscountPrice: number; /** * 后付费的折扣单价，单位:元注意：此字段可能返回 null，表示取不到有效值。 */ UnitPriceDiscount: number; /** * 折扣，如20.0代表2折。注意：此字段可能返回 null，表示取不到有效值。 */ Discount: number; } /** * DescribeClassicalLBHealthStatus返回参数结构体 */ export interface DescribeClassicalLBHealthStatusResponse { /** * 后端健康状态列表。注意：此字段可能返回 null，表示取不到有效值。 */ HealthList: Array<ClassicalHealth>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyLoadBalancerSla返回参数结构体 */ export interface ModifyLoadBalancerSlaResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeClsLogSet请求参数结构体 */ export declare type DescribeClsLogSetRequest = null; /** * 监听器的信息 */ export interface Listener { /** * 负载均衡监听器 ID */ ListenerId?: string; /** * 监听器协议 */ Protocol?: string; /** * 监听器端口 */ Port?: number; /** * 监听器绑定的证书信息注意：此字段可能返回 null，表示取不到有效值。 */ Certificate?: CertificateOutput; /** * 监听器的健康检查信息注意：此字段可能返回 null，表示取不到有效值。 */ HealthCheck?: HealthCheck; /** * 请求的调度方式。 WRR、LEAST_CONN、IP_HASH分别表示按权重轮询、最小连接数、IP Hash。注意：此字段可能返回 null，表示取不到有效值。 */ Scheduler?: string; /** * 会话保持时间注意：此字段可能返回 null，表示取不到有效值。 */ SessionExpireTime?: number; /** * 是否开启SNI特性，1：表示开启，0：表示不开启（本参数仅对于HTTPS监听器有意义）注意：此字段可能返回 null，表示取不到有效值。 */ SniSwitch?: number; /** * 监听器下的全部转发规则（本参数仅对于HTTP/HTTPS监听器有意义）注意：此字段可能返回 null，表示取不到有效值。 */ Rules?: Array<RuleOutput>; /** * 监听器的名称注意：此字段可能返回 null，表示取不到有效值。 */ ListenerName?: string; /** * 监听器的创建时间。注意：此字段可能返回 null，表示取不到有效值。 */ CreateTime?: string; /** * 端口段结束端口注意：此字段可能返回 null，表示取不到有效值。 */ EndPort?: number; /** * 后端服务器类型注意：此字段可能返回 null，表示取不到有效值。 */ TargetType?: string; /** * 绑定的目标组基本信息；当监听器绑定目标组时，会返回该字段注意：此字段可能返回 null，表示取不到有效值。 */ TargetGroup?: BasicTargetGroupInfo; /** * 会话保持类型。NORMAL表示默认会话保持类型。QUIC_CID 表示根据Quic Connection ID做会话保持。注意：此字段可能返回 null，表示取不到有效值。 */ SessionType?: string; /** * 是否开启长连接，1开启，0关闭，（本参数仅对于HTTP/HTTPS监听器有意义）注意：此字段可能返回 null，表示取不到有效值。 */ KeepaliveEnable?: number; /** * 仅支持Nat64 CLB TCP监听器注意：此字段可能返回 null，表示取不到有效值。 */ Toa?: boolean; /** * 解绑后端目标时，是否发RST给客户端，（此参数仅对于TCP监听器有意义）。注意：此字段可能返回 null，表示取不到有效值。 */ DeregisterTargetRst?: boolean; /** * 监听器的属性注意：此字段可能返回 null，表示取不到有效值。 */ AttrFlags?: Array<string>; /** * 绑定的目标组列表注意：此字段可能返回 null，表示取不到有效值。 */ TargetGroupList?: Array<BasicTargetGroupInfo>; /** * 监听器最大连接数，-1表示监听器维度不限速。注意：此字段可能返回 null，表示取不到有效值。 */ MaxConn?: number; /** * 监听器最大新增连接数，-1表示监听器维度不限速。注意：此字段可能返回 null，表示取不到有效值。 */ MaxCps?: number; /** * 空闲连接超时时间，仅支持TCP监听器。默认值:900；共享型实例和独占型实例取值范围：300～900，性能容量型实例取值范围:300～1980。注意：此字段可能返回 null，表示取不到有效值。 */ IdleConnectTimeout?: number; /** * 调度时间。触发强制重新调度后，长连接将会在设置的调度时间内断开并完成重新分配注意：此字段可能返回 null，表示取不到有效值。 */ RescheduleInterval?: number; } /** * 负载均衡流量数据。 */ export interface LoadBalancerTraffic { /** * 负载均衡ID */ LoadBalancerId: string; /** * 负载均衡名字 */ LoadBalancerName: string; /** * 负载均衡所在地域 */ Region: string; /** * 负载均衡的vip */ Vip: string; /** * 最大出带宽，单位：Mbps */ OutBandwidth: number; /** * CLB域名注意：此字段可能返回 null，表示取不到有效值。 */ Domain: string; } /** * 规格可用性 */ 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> 注意：此字段可能返回 null，表示取不到有效值。 */ SpecType?: string; /** * 规格可用性。资源可用性，"Available"：可用，"Unavailable"：不可用注意：此字段可能返回 null，表示取不到有效值。 */ Availability?: string; } /** * 配置内容 */ export interface ConfigListItem { /** * 配置ID */ UconfigId?: string; /** * 配置类型 */ ConfigType?: string; /** * 配置名字注意：此字段可能返回 null，表示取不到有效值。 */ ConfigName?: string; /** * 配置内容 */ ConfigContent?: string; /** * 增加配置时间 */ CreateTimestamp?: string; /** * 修改配置时间 */ UpdateTimestamp?: string; } /** * RegisterTargetsWithClassicalLB请求参数结构体 */ export interface RegisterTargetsWithClassicalLBRequest { /** * 负载均衡实例ID。 */ LoadBalancerId: string; /** * 后端服务信息。 */ Targets: Array<ClassicalTargetInfo>; } /** * 健康检查信息。注意，自定义探测相关参数目前只有少量区域灰度支持。 */ export interface HealthCheck { /** * 是否开启健康检查：1（开启）、0（关闭）。 */ HealthSwitch?: number; /** * 健康检查的响应超时时间，可选值：2~60，默认值：2，单位：秒。响应超时时间要小于检查间隔时间。注意：此字段可能返回 null，表示取不到有效值。 */ TimeOut?: number; /** * 健康检查探测间隔时间，默认值：5，IPv4 CLB实例的取值范围为：2-300，IPv6 CLB 实例的取值范围为：5-300。单位：秒。说明：部分老旧 IPv4 CLB实例的取值范围为：5-300。注意：此字段可能返回 null，表示取不到有效值。 */ IntervalTime?: number; /** * 健康阈值，默认值：3，表示当连续探测三次健康则表示该转发正常，可选值：2~10，单位：次。注意：此字段可能返回 null，表示取不到有效值。 */ HealthNum?: number; /** * 不健康阈值，默认值：3，表示当连续探测三次不健康则表示该转发异常，可选值：2~10，单位：次。注意：此字段可能返回 null，表示取不到有效值。 */ 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/HTTPS监听器和TCP监听器的HTTP健康检查方式。针对TCP监听器，当使用HTTP健康检查方式时，该参数为必填项）。注意：此字段可能返回 null，表示取不到有效值。 */ HttpCheckDomain?: string; /** * 健康检查方法（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式），默认值：HEAD，可选值HEAD或GET。注意：此字段可能返回 null，表示取不到有效值。 */ HttpCheckMethod?: string; /** * 自定义探测相关参数。健康检查端口，默认为后端服务的端口，除非您希望指定特定端口，否则建议留空。（仅适用于TCP/UDP监听器）。注意：此字段可能返回 null，表示取不到有效值。 */ CheckPort?: number; /** * 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查的输入格式，可取值：HEX或TEXT；取值为HEX时，SendContext和RecvContext的字符只能在01