tencentcloud-sdk-nodejs
Version:
2,089 lines (2,039 loc) • 131 kB
TypeScript
/**
* NotifyUnbindTarget请求参数结构体
*/
export interface NotifyUnbindTargetRequest {
/**
* 后端服务的IP列表。
> **VpcId**(**NumericVpcId**)、**Ips**必须同时设置。
*/
Ips: Array<string>;
/**
* 后端服务所属VPC的数字ID。
> **VpcId**(**NumericVpcId**)、**Ips**必须同时设置。
*/
NumericVpcId: number;
}
/**
* DescribeQuota请求参数结构体
*/
export interface DescribeQuotaRequest {
/**
* 配额类型列表。支持同时传入多个配额类型。查询资源级配额时,可配合 ResourceIds 传入对应资源ID;如需返回已使用量和可用量,可在 DisplayFields 中传入 used、available。
枚举说明:
- alb_quota_loadbalancers_num:每个地域可创建的 ALB 实例数。
- alb_quota_targetgroups_num:每个地域可创建的 ALB 目标组数。
- alb_quota_loadbalancer_listeners_num:每个 ALB 实例可创建的监听器数,ResourceIds 填写 ALB 实例 ID。
- alb_quota_loadbalancer_rules_num:每个 ALB 实例可添加的转发规则数,不计入默认规则,ResourceIds 填写 ALB 实例 ID。
- alb_quota_loadbalancer_certificates_num:每个 ALB 实例可添加的扩展证书数,不计入默认证书,ResourceIds 填写 ALB 实例 ID。
- alb_quota_loadbalancer_targetgroup_num:每个 ALB 实例可绑定的目标组数,ResourceIds 填写 ALB 实例 ID。
- alb_quota_loadbalancer_servers_num:每个 ALB 实例可添加的后端服务器数,ResourceIds 填写 ALB 实例 ID。
- alb_quota_server_added_num:单个后端服务器 IP 可被添加到 ALB 后端目标组的次数。
- alb_quota_targetgroup_attached_num:每个目标组可被 ALB 转发规则关联的次数,ResourceIds 填写目标组 ID。
- alb_quota_targetgroup_targets_num:每个目标组支持的后端服务器数,适用于 IP 和端口类型后端,ResourceIds 填写目标组 ID。
- alb_quota_targetgroup_targets_num_scf:每个目标组支持的 SCF 函数后端数,ResourceIds 填写目标组 ID。
- alb_quota_max_request_timeout:创建监听器时可配置的连接请求最大超时时间。
- alb_quota_max_idle_timeout:创建监听器时可配置的连接空闲最大超时时间。
- alb_quota_listener_certificates_num:单个监听器可添加的证书数量,ResourceIds 填写监听器 ID。
- alb_quota_rule_targetgroups_num:单条转发规则可绑定的目标组数量。
- alb_quota_rule_conditions_num:单条转发规则可添加的匹配条件条目数。
- alb_quota_rule_wildcards_num:单条转发规则可添加的包含通配符的匹配条目数。
- alb_quota_rule_actions_num:单条转发规则可添加的动作条目数。
- alb_quota_cipher_template_listeners_num:单个加密套件模板可关联的监听器数量。
- alb_quota_healthcheck_templates_num:每个地域可创建的健康检查模板数。
- alb_quota_securitygroup_templates_num:单个 ALB 实例支持绑定的安全组数量。
- alb_quota_securitygroup_rules_per_sg_num:单个 ALB 实例中单个安全组支持的规则条目数。
- alb_quota_security_policies_num:每个地域可创建的自定义安全策略数。
*/
QuotaTypes: Array<string>;
/**
* 显示字段列表,用于控制是否额外返回用量信息。支持 used、available:used 表示返回当前已使用量,available 表示返回当前剩余可用量。QuotaType 和 Limit 总是返回;ResourceId 会在请求传入 ResourceIds 时返回。
*/
DisplayFields?: Array<string>;
/**
* 资源ID列表。用于查询具体资源维度的配额和用量;不传时查询账号或地域维度的默认配额配置。资源ID的类型由 QuotaTypes 决定,例如 ALB 实例级配额填写 ALB 实例 ID,监听器级配额填写监听器 ID,目标组级配额填写目标组 ID。
*/
ResourceIds?: Array<string>;
}
/**
* InquirePriceCreateLoadBalancer请求参数结构体
*/
export interface InquirePriceCreateLoadBalancerRequest {
/**
* 实例的计费类型。默认POSTPAID_BY_HOUR,仅取值 POSTPAID_BY_HOUR:表示按量计费。
*/
ChargeType?: string;
}
/**
* DeleteRules请求参数结构体
*/
export interface DeleteRulesRequest {
/**
* 监听器 ID,格式为 lst- 后接 8 位字母数字。
*/
ListenerId: string;
/**
* 负载均衡实例 ID,格式为 alb- 后接 8 位字母数字。
*/
LoadBalancerId: string;
/**
* 转发规则 ID 列表,ID 格式为 rule- 后接 8 位字母数字。
*/
RuleIds: Array<string>;
/**
* 是否只预检查此次请求。
*/
DryRun?: boolean;
}
/**
* SetLoadBalancerSecurityGroups返回参数结构体
*/
export interface SetLoadBalancerSecurityGroupsResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 用于购买或者修改使用的可用区及子网映射结构体
*/
export interface ZoneMappingsItem {
/**
* <p>子网 ID。</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
SubnetId: string;
/**
* <p>可用区ID。最多支持添加10个可用区。若当前地域支持2个及以上的可用区,至少需要添加2个可用区。<br>您可以通过调用<a href="https://cloud.tencent.com/document/api/1822/133727">DescribeZones</a>接口获取可用区ID对应的可用区的信息。</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
ZoneId: string;
/**
* <p>公网实例绑定的EIP实例ID。</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
LoadBalancerAddress?: LoadBalancerAddress;
}
/**
* 负载均衡详细信息
*/
export interface LoadBalancerDetail {
/**
* 访问日志配置。
*/
AccessLogConfig?: AccessLogConfig;
/**
* IP 地址版本,取值 IPv4 或 IPv6。
*/
AddressIpVersion?: string;
/**
* 应用型负载均衡实例的网络地址类型。取值:
- **Internet/Public**:负载均衡具有公网IP地址,DNS域名被解析到公网IP,因此可以在公网环境访问。
- **Intranet/Internal**:负载均衡只有私网IP地址,DNS域名被解析到私网IP,因此只能被负载均衡所在VPC的内网环境访问。
*/
AddressType?: string;
/**
* 资源创建时间,格式为`yyyy-MM-ddTHH:mm:ss±hh:mm`。
*/
CreateTime?: string;
/**
* 删除保护设置信息。
*/
DeletionProtection?: DeletionProtectionConfig;
/**
* DNS域名。
*/
Domain?: string;
/**
* 负载均衡实例付计费配置信息
*/
LoadBalancerBillingConfig?: LoadBalancerBillingConfig;
/**
* 负载均衡实例 ID,格式为 alb- 后接 8 位字母数字。
*/
LoadBalancerId?: string;
/**
* 实例名称。
长度为1~80个字符,可包含中文、字母、数字、短划线(-)、正斜线(/)、半角句号(.)和下划线(_)。
*/
LoadBalancerName?: string;
/**
* 应用型负载均衡操作锁配置。
*/
LoadBalancerOperationLocks?: Array<LoadBalancerOperationLocksItem>;
/**
* 应用型负载均衡实例状态。取值:
- **Provisioning**:创建中。
- **Active**: 运行中。
- **Configuring**: 变配中。
- **Deleting**:删除中。
- **ProvisionFailed**:创建失败。
- **ConfigureFailed**:变配失败。
- **DeletionFailed**:删除失败。
- **Abnormal**:异常状态,具体异常原因参见LoadBalancerOperationLocks字段。
*/
LoadBalancerStatus?: string;
/**
* 修改保护设置信息。
*/
ModificationProtection?: ModificationProtectionInfo;
/**
* 应用型负载均衡实例绑定的安全组ID集合。
*/
SecurityGroupIds?: Array<string>;
/**
* 标签。
*/
Tags?: Array<TagInfo>;
/**
* 私有网络 ID。
*/
VpcId?: string;
/**
* 可用区及子网映射列表,最多返回10个可用区。若当前地域支持2个及以上可用区,至少返回2个及以上可用区。
*/
ZoneMappings?: Array<ZoneMappingInfo>;
}
/**
* CreateLoadBalancer请求参数结构体
*/
export interface CreateLoadBalancerRequest {
/**
* 应用型负载均衡的地址类型。取值:
- **Internet**:负载均衡具有公网IP地址,DNS域名被解析到公网IP,因此可以在公网环境访问。
- **Intranet**:负载均衡只有私网IP地址,DNS域名被解析到私网IP,因此只能被负载均衡所在VPC的内网环境访问。
*/
AddressType: string;
/**
* 应用型负载均衡实例计费配置。
*/
LoadBalancerBillingConfig: LoadBalancerBillingConfig;
/**
* 私有网络 ID。
*/
VpcId: string;
/**
* 可用区及私有网络子网映射列表,最多支持添加10个可用区。若当前地域支持2个及以上的可用区,至少需要添加2个可用区。
*/
ZoneMappings: Array<ZoneMappingsItem>;
/**
* IP 地址版本,取值 IPv4 或 IPv6。
*/
AddressIpVersion?: string;
/**
* 客户端Token,用于保证请求的幂等性。
从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。
*/
ClientToken?: string;
/**
* 删除保护配置。
*/
DeleteProtection?: DeletionProtectionConfig;
/**
* 是否只预检此次请求,取值:
- **true**:发送检查请求,不会创建应用型负载均衡实例。检查项包括是否填写了必需参数、请求格式和业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。
- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接进行操作。
*/
DryRun?: boolean;
/**
* EIP 地址类型,可取值:
- **EIP**: 普通弹性公网 IP
- **AntiDDoSEIP**: 高防EIP
- **AnycastEIP**: 加速 EIP
- **HighQualityEIP**: 精品 IP。仅新加坡和中国香港支持精品IP。
- **ResidentialEIP**: 原生 IP
不传默认是EIP。
*/
InternetAddressType?: string;
/**
* 应用型负载均衡实例名称。长度为1~80个字符,可包含中文、字母、数字、短划线(-)、正斜线(/)、半角句号(.)和下划线(_)。
*/
LoadBalancerName?: string;
/**
* 标签。
*/
Tags?: Array<TagInfo>;
}
/**
* ModifyLoadBalancerAttributes请求参数结构体
*/
export interface ModifyLoadBalancerAttributesRequest {
/**
* 负载均衡实例 ID,格式为 alb- 后接 8 位字母数字。
*/
LoadBalancerId: string;
/**
* 客户端Token,用于保证请求的幂等性。
从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。
> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。
*/
ClientToken?: string;
/**
* 删除保护配置
*/
DeletionProtection?: DeletionProtectionConfig;
/**
* 是否只预检此次请求,取值:
- **true**:发送检查请求,不会修改应用型负载均衡实例的属性。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。
- **false**(默认值):发送正常请求,通过检查后返回`HTTP_2xx`状态码并直接进行操作。
*/
DryRun?: boolean;
/**
* 应用型负载均衡实例名称。长度为1~80个字符,可包含中文、字母、数字、短划线(-)、正斜线(/)、半角句号(.)和下划线(_)。
*/
LoadBalancerName?: string;
}
/**
* DisassociateBandwidthPackageFromLoadBalancer请求参数结构体
*/
export interface DisassociateBandwidthPackageFromLoadBalancerRequest {
/**
* 共享带宽包 ID。
*/
BandwidthPackageId: string;
/**
* 负载均衡实例 ID,格式为 alb- 后接 8 位字母数字。
*/
LoadBalancerId: string;
/**
* 客户端Token,用于保证请求的幂等性。
从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。
> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。
*/
ClientToken?: string;
/**
* 是否只预检此次请求。取值:
- **true**:发送检查请求,不会将共享带宽包从负载均衡实例中移除。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。
- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接进行操作。
*/
DryRun?: boolean;
}
/**
* CreateHealthCheckTemplate请求参数结构体
*/
export interface CreateHealthCheckTemplateRequest {
/**
* 是否预览此次请求。
- **false**(默认):发送普通请求,直接修改健康检查模板。
- **true**:发送预览请求,检查修改健康检查模板的参数、格式、业务限制等是否符合要求。
*/
DryRun?: boolean;
/**
* 健康检查状态码。取值:
- 当健康检查协议为**HTTP/HTTPS**时:
- **http_1xx**
- **http_2xx**(默认值)
- **http_3xx**
- **http_4xx**
- **http_5xx**
- 当健康检查协议为**GRPC/GRPCS**时:默认值为**12**,数值范围为**0-99**,输入值可为数值、多个数值或者范围以及相互组合,如:
- **"20"**
- **"0-99"**
*/
HealthCheckCodes?: Array<string>;
/**
* 判定后端服务健康的阈值,当健康检查连续成功多少次后,后端服务的状态由**不健康**变为**健康**。
取值范围:**2**-**10**。
默认值:**2**。
*/
HealthCheckHealthyThreshold?: number;
/**
* 健康检查域名。
长度限制为 **1-255** 个字符。
可包含小写字母、数字、短划线(-)和半角句号(.)。
> 仅当 **HealthCheckProtocol** 设置为 **HTTP/HTTPS/GRPC/GRPCS** 时,该参数生效。
*/
HealthCheckHost?: string;
/**
* 健康检查 HTTP 协议版本,取值:
- **HTTP1.1**(默认)
- **HTTP1.0**
> 仅当**HealthCheckProtocol**设置为**HTTP** 或 **HTTPS** 时,该参数生效。
*/
HealthCheckHttpVersion?: string;
/**
* 健康检查的时间间隔。单位:秒。 取值范围:**2**-**300**。 默认值:**5**。
*/
HealthCheckInterval?: number;
/**
* 健康检查方法,取值: - **GET** - **HEAD**(默认值)
> 仅当**HealthCheckProtocol**设置为**HTTP** 或 **HTTPS** 时,该参数生效。
*/
HealthCheckMethod?: string;
/**
* 健康检查的转发规则路径。 长度为 **1-80** 个字符,只能使用字母、数字、字符`-/.%?#&=`以及扩展字符`_;~!()*[]@$^:',+`。 URL 必须以正斜线(/)开头。
> 仅当**HealthCheckProtocol**为**HTTP/HTTPS/GRPC/GRPCS**时,转发规则路径参数生效。
*/
HealthCheckPath?: string;
/**
* 健康检查访问后端服务器的端口。 取值范围:**0-65535**。 默认值:**0**,表示后端服务器的端口。
*/
HealthCheckPort?: number;
/**
* 健康检查协议。取值:
- **HTTP**(默认):通过发送 HEAD 或 GET 请求模拟浏览器的访问行为来检查服务器应用是否健康。
- **HTTPS**:通过发送 HEAD 或 GET 请求模拟浏览器的访问行为来检查服务器应用是否健康。(数据加密,相比 HTTP 更安全。)
- **TCP**:通过发送 SYN 握手报文来检测服务器端口是否存活。
- **GRPC**:通过发送 POST 或 GET 请求来检查服务器应用是否健康。
- **GRPCS**:通过发送 POST 或 GET 请求来检查服务器应用是否健康。
*/
HealthCheckProtocol?: string;
/**
* 健康检查模板名称。长度为 **1-255** 个字符,可包含数字、大小写字母、中文、半角句号(.)、下划线(_)和短划线(-)。
*/
HealthCheckTemplateName?: string;
/**
* 健康检查的响应超时时间。单位:秒。
取值范围:**2**-**60**。
默认值:**2**。
*/
HealthCheckTimeout?: number;
/**
* 判定后端服务不健康的阈值,当健康检查连续失败多少次后,后端服务的状态由**健康**变为**不健康**。
取值范围:**2**-**10**。
默认值:**2**。
*/
HealthCheckUnhealthyThreshold?: number;
/**
* 标签。
*/
Tags?: Array<TagInfo>;
}
/**
* DescribeListenerHealthStatus请求参数结构体
*/
export interface DescribeListenerHealthStatusRequest {
/**
* 监听器 ID,格式为 lst- 后接 8 位字母数字。
*/
ListenerId: string;
/**
* 负载均衡实例 ID,格式为 alb- 后接 8 位字母数字。
*/
LoadBalancerId: string;
/**
* 是否包含转发规则的健康检查结果。为false时只返回默认转发规则的健康状态,为true时返回全部规则的健康状态(包含默认规则)。
取值:
true:是。
false(默认值):否。
*/
IncludeRule?: boolean;
/**
* 本次读取的最大数据记录数量。
取值: 1~100。
默认值: 20
*/
MaxResults?: number;
/**
* 下一页查询的Token值。第一次查询时,无需填写。
*/
NextToken?: string;
}
/**
* HTTP Header信息
*/
export interface HTTPHeaderInfo {
/**
* HTTP Header的键,长度1 ~ 40个字符,支持的字符集为:a-z A-Z 0-9 - _ 。
不支持中文,不支持Host,Cookie。
*/
Key: string;
/**
* HTTP Header的值,长度1 ~ 128个字符,支持可打印字符。
不支持",开头和结尾不能是空格,结尾不能是\。
*/
Values: Array<string>;
}
/**
* DeleteHealthCheckTemplates请求参数结构体
*/
export interface DeleteHealthCheckTemplatesRequest {
/**
* 健康检查模板 ID 列表,ID 格式为 hct- 后接字母数字。
*/
HealthCheckTemplateIds: Array<string>;
/**
* 是否预览此次请求。
- **false**(默认):发送普通请求,直接删除模板。
- **true**:发送预览请求,检查删除模板的参数、格式、业务限制等是否符合要求。
*/
DryRun?: boolean;
}
/**
* ModifyLoadBalancerAttributes返回参数结构体
*/
export interface ModifyLoadBalancerAttributesResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 应用型负载均衡可用区子网映射中的 IP 信息数据结构
*/
export interface LoadBalancerAddress {
/**
* IPv4 地址列表
*/
IPv4Address?: Array<IPAddressInfo>;
/**
* IPv6 地址列表
*/
IPv6Address?: Array<IPAddressInfo>;
}
/**
* NotifyUnbindTarget返回参数结构体
*/
export interface NotifyUnbindTargetResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 后端服务输出参数。
*/
export interface TargetOutput {
/**
* 弹性网卡 ID。
*/
EniId?: string;
/**
* 后端服务器使用的端口。取值范围:**1 - 65535**。
*/
Port?: number;
/**
* 后端服务实例 ID,CVM 实例格式为 ins- 后接 8 位字母数字。
*/
TargetId?: string;
/**
* 后端服务IP。**TargetIp**和**TargetId**需要至少传一个。
- 当服务器组为 **Instance** 类型时,该参数为 **Eni** 的主内网 IP 或辅助内网 IP。
*/
TargetIp?: string;
/**
* 后端服务名称。当前只有CVM后端类型后端服务返回有效名称。
*/
TargetName?: string;
/**
* 后端服务的状态。取值:
- **Adding**:添加中。
- **Active**:正常可用状态。
- **Configuring**:配置中。
- **Removing**:移除中。
*/
TargetStatus?: string;
/**
* 后端服务类型。
*/
TargetType?: string;
/**
* 后端服务的权重,取值范围:**0 - 100**。默认值为**100**。如果设置权重为**0**,则不会将请求转发给该后端服务。
*/
Weight?: number;
}
/**
* CreateHealthCheckTemplate返回参数结构体
*/
export interface CreateHealthCheckTemplateResponse {
/**
* 健康检查模板 ID,格式为 hct- 后接字母数字。所有接口(创建、查询、修改、删除)均使用 hct- 前缀。
*/
HealthCheckTemplateId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyHealthCheckTemplate请求参数结构体
*/
export interface ModifyHealthCheckTemplateRequest {
/**
* <p>健康检查模板 ID,格式为 hct- 后接字母数字。</p>
*/
HealthCheckTemplateId: string;
/**
* <p>是否预览此次请求。</p><ul><li><strong>false</strong>(默认):发送普通请求,直接修改健康检查模板。</li><li><strong>true</strong>:发送预览请求,检查修改健康检查模板的参数、格式、业务限制等是否符合要求。</li></ul>
*/
DryRun?: boolean;
/**
* <p>健康检查状态码。取值:</p><ul><li>当健康检查协议为<strong>HTTP/HTTPS</strong>时:<ul><li><strong>http_1xx</strong></li><li><strong>http_2xx</strong>(默认值)</li><li><strong>http_3xx</strong></li><li><strong>http_4xx</strong></li><li><strong>http_5xx</strong></li></ul></li><li>当健康检查协议为<strong>GRPC/GRPCS</strong>时:默认值为<strong>12</strong>,数值范围为<strong>0-99</strong>,输入值可为数值、多个数值或者范围以及相互组合,如:<ul><li><strong>"20"</strong></li><li><strong>"0-99"</strong></li></ul></li></ul>
*/
HealthCheckCodes?: Array<string>;
/**
* <p>判定后端服务健康的阈值,当健康检查连续成功多少次后,后端服务的状态由<strong>不健康</strong>变为<strong>健康</strong>。<br>取值范围:<strong>2</strong>-<strong>10</strong>。<br>默认值:<strong>2</strong>。</p>
*/
HealthCheckHealthyThreshold?: number;
/**
* <p>健康检查域名。<br>长度限制为 <strong>1-255</strong> 个字符。<br>可包含小写字母、数字、短划线(-)和半角句号(.)。</p><blockquote><p>仅当 <strong>HealthCheckProtocol</strong> 设置为 <strong>HTTP/HTTPS/GRPC/GRPCS</strong> 时,该参数生效。</p></blockquote>
*/
HealthCheckHost?: string;
/**
* <p>健康检查 HTTP 协议版本,取值:</p><ul><li><strong>HTTP1.1</strong>(默认)</li><li><strong>HTTP1.0</strong> <blockquote><p>仅当<strong>HealthCheckProtocol</strong>设置为<strong>HTTP</strong> 或 <strong>HTTPS</strong> 时,该参数生效。</p></blockquote></li></ul>
*/
HealthCheckHttpVersion?: string;
/**
* <p>健康检查的时间间隔。单位:秒。 取值范围:<strong>2</strong>-<strong>300</strong>。 默认值:<strong>5</strong>。</p>
*/
HealthCheckInterval?: number;
/**
* <p>健康检查方法,取值: - <strong>GET</strong> - <strong>HEAD</strong>(默认值) </p><blockquote><p>仅当<strong>HealthCheckProtocol</strong>设置为<strong>HTTP</strong> 或 <strong>HTTPS</strong> 时,该参数生效。</p></blockquote>
*/
HealthCheckMethod?: string;
/**
* <p>健康检查的转发规则路径。 长度为 <strong>1-80</strong> 个字符,只能使用字母、数字、字符<code>-/.%?#&=</code>以及扩展字符<code>_;~!()*[]@$^:',+</code>。 URL 必须以正斜线(/)开头。 </p><blockquote><p>仅当<strong>HealthCheckProtocol</strong>为<strong>HTTP/HTTPS/GRPC/GRPCS</strong>时,转发规则路径参数生效。</p></blockquote>
*/
HealthCheckPath?: string;
/**
* <p>健康检查访问后端服务器的端口。 取值范围:<strong>0-65535</strong>。 默认值:<strong>0</strong>,表示后端服务器的端口。</p>
*/
HealthCheckPort?: number;
/**
* <p>健康检查协议。取值:</p><ul><li><strong>HTTP</strong>(默认):通过发送 HEAD 或 GET 请求模拟浏览器的访问行为来检查服务器应用是否健康。</li><li><strong>HTTPS</strong>:通过发送 HEAD 或 GET 请求模拟浏览器的访问行为来检查服务器应用是否健康。(数据加密,相比 HTTP 更安全。)</li><li><strong>TCP</strong>:通过发送 SYN 握手报文来检测服务器端口是否存活。</li><li><strong>GRPC</strong>:通过发送 POST 或 GET 请求来检查服务器应用是否健康。</li><li><strong>GRPCS</strong>:通过发送 POST 或 GET 请求来检查服务器应用是否健康。</li></ul>
*/
HealthCheckProtocol?: string;
/**
* <p>健康检查模板名称。长度为 <strong>1-255</strong> 个字符,可包含数字、大小写字母、中文、半角句号(.)、下划线(_)和短划线(-)。</p>
*/
HealthCheckTemplateName?: string;
/**
* <p>健康检查的响应超时时间。单位:秒。<br>取值范围:<strong>2</strong>-<strong>60</strong>。<br>默认值:<strong>2</strong>。</p>
*/
HealthCheckTimeout?: number;
/**
* <p>判定后端服务不健康的阈值,当健康检查连续失败多少次后,后端服务的状态由<strong>健康</strong>变为<strong>不健康</strong>。<br>取值范围:<strong>2</strong>-<strong>10</strong>。<br>默认值:<strong>2</strong>。</p>
*/
HealthCheckUnhealthyThreshold?: number;
}
/**
* AssociateListenerAdditionalCertificates请求参数结构体
*/
export interface AssociateListenerAdditionalCertificatesRequest {
/**
* 扩展证书 ID 列表。
*/
CertificateIds: Array<string>;
/**
* 监听器 ID,格式为 lst- 后接 8 位字母数字。
*/
ListenerId: string;
/**
* 负载均衡实例 ID,格式为 alb- 后接 8 位字母数字。
*/
LoadBalancerId: string;
/**
* 客户端 Token,用于保证请求的幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。
若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
*/
ClientToken?: string;
/**
* 是否只预检此次请求,取值:
true:发送检查请求,不会为HTTPS和QUIC监听器添加扩展证书。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation。
false(默认值):发送正常请求,通过检查后返回HTTP2xx状态码并直接进行操作。
*/
DryRun?: string;
}
/**
* 应用型负载均衡可用区子网映射中的 IP 信息数据结构
*/
export interface IPAddressInfo {
/**
* IP 地址
*/
Address?: string;
/**
* EIP AddressId
*/
AddressId?: string;
}
/**
* DescribeListenerDetail返回参数结构体
*/
export interface DescribeListenerDetailResponse {
/**
* 监听器绑定的CA证书ID列表。
*/
CaCertificateIds?: Array<string>;
/**
* 是否开启双向认证。
*/
CaEnabled?: boolean;
/**
* 服务器证书 ID 列表。
*/
CertificateIds?: Array<string>;
/**
* 监听器实例的创建时间。格式:ISO 8601(例如 2025-01-01T08:30:00+08:00)
*/
CreateTime?: string;
/**
* 规则动作列表。
*/
DefaultActions?: Array<DefaultAction>;
/**
* 是否启用 Gzip 压缩。
*/
GzipEnabled?: boolean;
/**
* 是否开启HTTP/2特性。
*/
Http2Enabled?: boolean;
/**
* 指定连接空闲超时时间。单位:秒。
*/
IdleTimeout?: number;
/**
* 监听器 ID,格式为 lst- 后接 8 位字母数字。
*/
ListenerId?: string;
/**
* 自定义监听名称。
*/
ListenerName?: string;
/**
* 负载均衡实例前端使用的端口。
*/
ListenerPort?: number;
/**
* 监听协议。
*/
ListenerProtocol?: string;
/**
* 监听器状态。取值:=
- **Active**: 运行中。
- **Provisioning**:创建中。
- **Configuring**:变配中。
- **ProvisionFailed**:创建失败
*/
ListenerStatus?: string;
/**
* 负载均衡实例 ID,格式为 alb- 后接 8 位字母数字。
*/
LoadBalancerId?: string;
/**
* 监听器实例的最后变更时间。格式:ISO 8601(例如 2025-01-01T08:30:00+08:00)
*/
ModifyTime?: string;
/**
* 请求超时时间。单位:秒。
*/
RequestTimeout?: number;
/**
* 安全策略 ID,格式为 tls- 后接 8 位字母数字。
*/
SecurityPolicyId?: string;
/**
* 标签。
*/
Tags?: Array<TagInfo>;
/**
* XForwardedFor配置。
*/
XForwardedForConfig?: XForwardedForConfig;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 转发规则动作
*/
export interface RuleAction {
/**
* 转发动作执行顺序,不能重复,按从小到大顺序执行。取值范围:1 ~ 50000。
*/
Order: number;
/**
* 转发动作类型。取值:
TargetGroup:转发至目标组。
Redirect:重定向。
FixedResponse:返回固定内容。
Rewrite:重写。
InsertHeader:写入HTTP Header。
RemoveHeader:删除HTTP Header。
转发动作必选包含TargetGroup,Redirect,FixedResponse其中一个,并且执行顺序放在最后。
*/
Type: string;
/**
* 固定响应内容配置。
*/
FixedResponseConfig?: FixedResponseInfo;
/**
* 插入HTTP Header配置。
*/
InsertHeaderConfig?: InsertHTTPHeaderInfo;
/**
* 重定向配置。除HttpCode外,其他配置不能都使用默认值。
*/
RedirectConfig?: HTTPRedirectInfo;
/**
* 删除HTTP Header配置。
*/
RemoveHeaderConfig?: RemoveHTTPHeaderInfo;
/**
* 重写配置。
*/
RewriteConfig?: HTTPRewriteInfo;
/**
* 转发目标组配置。
*/
TargetGroupConfig?: TargetGroupConfig;
}
/**
* DescribeRules返回参数结构体
*/
export interface DescribeRulesResponse {
/**
* 下一次查询的Token值,如果当前是最后一页,返回为空。
*/
NextToken?: string;
/**
* 转发规则列表。
*/
Rules?: Array<RuleOutput>;
/**
* 总的转发规则个数(根据监听器ID、规则ID等条件过滤后)。
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeTargetGroups返回参数结构体
*/
export interface DescribeTargetGroupsResponse {
/**
* 下一次查询的Token值,如果当前是最后一页,返回为空。
注意:此字段可能返回 null,表示取不到有效值。
*/
NextToken?: string;
/**
* 目标组信息。
*/
TargetGroups?: Array<TargetGroupOutput>;
/**
* 目标组总数。
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RemoveTargetsFromTargetGroup请求参数结构体
*/
export interface RemoveTargetsFromTargetGroupRequest {
/**
* 目标组 ID,格式为 lbtg- 后接 8 位字母数字。
*/
TargetGroupId: string;
/**
* 需要从目标组移除的后端服务列表。单次请求最多移除 **50** 个后端服务。
*/
Targets: Array<TargetToRemove>;
/**
* 是否预览此次请求。
- **false**(默认):发送普通请求,直接移除后端服务。
- **true**:发送预览请求,检查移除后端服务的参数、格式、业务限制等是否符合要求。
*/
DryRun?: boolean;
}
/**
* DescribeListenerDetail请求参数结构体
*/
export interface DescribeListenerDetailRequest {
/**
* 监听器 ID,格式为 lst- 后接 8 位字母数字。
*/
ListenerId: string;
/**
* 负载均衡实例 ID,格式为 alb- 后接 8 位字母数字。
*/
LoadBalancerId: string;
}
/**
* AddTargetsToTargetGroup请求参数结构体
*/
export interface AddTargetsToTargetGroupRequest {
/**
* 目标组 ID,格式为 lbtg- 后接 8 位字母数字。
*/
TargetGroupId: string;
/**
* 需要添加至目标组的后端服务列表。单次请求最多支持添加 **50** 个后端服务。
*/
Targets: Array<TargetToAdd>;
/**
* 是否预览此次请求。
- **false**(默认):发送普通请求,直接添加后端服务至目标组。
- **true**:发送预览请求,检查添加后端服务的参数、格式、业务限制等是否符合要求。
*/
DryRun?: boolean;
}
/**
* ModifyListenerAttributes返回参数结构体
*/
export interface ModifyListenerAttributesResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 访问日志配置。
*/
export interface AccessLogConfig {
/**
* 负载均衡日志服务(CLS)的日志集ID
注意:此字段可能返回 null,表示取不到有效值。
*/
LogSetId?: string;
/**
* 负载均衡日志服务(CLS)的日志主题ID
注意:此字段可能返回 null,表示取不到有效值。
*/
LogTopicId?: string;
}
/**
* ModifyRulesAttributes返回参数结构体
*/
export interface ModifyRulesAttributesResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* HTTP重写信息
*/
export interface HTTPRewriteInfo {
/**
* <p>重写的主机地址,默认值${host}。长度3 ~ 128个字符,支持的字符集为:a-z 0-9 _ . -。</p>
*/
Host?: string;
/**
* <p>重写的路径,默认值${path}。长度1 ~ 128个字符,支持的字符集为:a-z A-Z 0-9 ? = _ . - / : 。</p>
*/
Path?: string;
/**
* <p>重写的查询字符串,默认值${query}。长度1 ~ 128字符,支持可打印字符,不支持 #[]{}|<>& 和空格。</p>
*/
Query?: string;
}
/**
* AssociateBandwidthPackageWithLoadBalancer返回参数结构体
*/
export interface AssociateBandwidthPackageWithLoadBalancerResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeListeners返回参数结构体
*/
export interface DescribeListenersResponse {
/**
* 监听器信息。
*/
Listeners?: Array<ListenerOutput>;
/**
* 负载均衡实例 ID,格式为 alb- 后接 8 位字母数字。
*/
LoadBalancerId?: string;
/**
* 本次读取的最大数据记录数量。
*/
MaxResults?: number;
/**
* 下一次查询的令牌。
*/
NextToken?: string;
/**
* 总条目数。
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AssociateBandwidthPackageWithLoadBalancer请求参数结构体
*/
export interface AssociateBandwidthPackageWithLoadBalancerRequest {
/**
* 共享带宽包 ID。
*/
BandwidthPackageId: string;
/**
* 负载均衡实例 ID,格式为 alb- 后接 8 位字母数字。
*/
LoadBalancerId: string;
/**
* 客户端Token,用于保证请求的幂等性。
从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。
> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。
*/
ClientToken?: string;
/**
* 是否只预检此次请求。取值:
- **true**:发送检查请求,不会将共享带宽包绑定到负载均衡实例。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。
- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接进行操作。
*/
DryRun?: boolean;
}
/**
* 转发配置
*/
export interface XForwardedForConfig {
/**
* 是否通过 ALB-ID 头字段获取负载均衡实例ID。
- **true**:是。
- **false**:否。
*/
XForwardedForAlbIdEnabled?: boolean;
/**
* 是否通过X-Forwarded-Client-srcport头字段获取访问负载均衡实例客户端的端口。
- **true**:是。
- **false**:否。
*/
XForwardedForClientSrcPortEnabled?: boolean;
/**
* 是否开启通过X-Forwarded-Host头字段获取访问负载均衡实例客户端的域名。
- **true**:是。
- **false**:否。
*/
XForwardedForHostEnabled?: boolean;
/**
* 指定如何处理 X-Forwarded-For(XFF)HTTP 头字段。
- **append**: 附加模式(默认),将客户端的真实 IP 地址附加到 X-Forwarded-For 头的末尾,保留原有的 XFF 链路信息
- **remove**: 删除模式,移除 X-Forwarded-For 头字段,不将该头传递给后端服务器
- **passthrough**: 透传模式,保持 X-Forwarded-For 头不变,直接透传给后端服务器,不做任何修改
*/
XForwardedForMode?: string;
/**
* 是否通过X-Forwarded-Port头字段获取负载均衡实例的监听端口。
- **true**:是。
- **false**:否。
*/
XForwardedForPortEnabled?: boolean;
/**
* 是否通过X-Forwarded-Proto头字段获取负载均衡实例的监听协议。
- **true**:是。
- **false**:否。
*/
XForwardedForProtoEnabled?: boolean;
/**
* 是否通过 X-Tencent-Client-IDN 头访问 客户端证书的颁发者 $ssl_client_i_dn。
- **true**:是。
- **false**:否。
*/
XTencentClientIDNEnabled?: boolean;
/**
* 是否通过 X-Tencent-Client-SDN 头访问客户端证书的主题$ssl_client_s_dn。
- **true**:是。
- **false**:否。
*/
XTencentClientSDNEnabled?: boolean;
/**
* 是否通过 X-Tencent-Client-Serial 头访问 客户端证书的序列号 $ssl_client_serial。
- **true**:是。
- **false**:否。
*/
XTencentClientSerialEnabled?: boolean;
/**
* 是通过 X-Tencent-Client-Verify 头访问 客户端证书的验证结果 $ssl_client_verify。
- **true**:是。
- **false**:否。
*/
XTencentClientVerifyEnabled?: boolean;
}
/**
* DescribeTargetGroups请求参数结构体
*/
export interface DescribeTargetGroupsRequest {
/**
* 过滤器。通过指定的过滤条件来查询后端服务,支持:
- Name的值为**VpcId**。通过VPC实例来筛选目标组。**Values**的值为VPC唯一ID列表。
- Name的值为**TargetType**。通过后端服务类型来筛选目标组。**Values**的值可以取为**Instance**。
- Name的值为**TargetGroupName**。通过目标组名称来筛选目标组。**Values**的值为目标组名称列表。
- Name的值为**Protocol**。通过目标组后端服务协议来筛选目标组。**Values**的值为目标组后端服务协议列表。
- 通过标签方式筛选。
*/
Filters?: Array<Filter>;
/**
* 返回列表的数量,默认为**20**,最大值为**100**。
*/
MaxResults?: number;
/**
* 下一次查询的Token值。第一次查询和没有下一次查询时,无需填写。
如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。
*/
NextToken?: string;
/**
* 目标组 ID 列表,ID 格式为 lbtg- 后接 8 位字母数字。
*/
TargetGroupIds?: Array<string>;
}
/**
* 单个配额项的查询结果。每个结果对应一个配额类型;当请求中传入 ResourceIds 时,每个结果还会对应一个具体资源。
*/
export interface QuotaInfo {
/**
* 当前剩余可用量,计算方式为 Limit - Used。仅当请求参数 DisplayFields 包含 available 时返回有效值;未请求时不返回或为空。
注意:此字段可能返回 null,表示取不到有效值。
*/
Available?: number;
/**
* 配额上限值。不同配额类型的单位不同,通常表示资源个数;超时时间类配额表示秒。
*/
Limit?: number;
/**
* 配额类型,与请求参数 QuotaTypes 中的取值对应。每种配额类型的含义请参考 QuotaTypes 参数说明。
*/
QuotaType?: string;
/**
* 资源 ID。
注意:此字段可能返回 null,表示取不到有效值。
*/
ResourceId?: string;
/**
* 当前已使用量。仅当请求参数 DisplayFields 包含 used 时返回有效值;未请求时不返回或为空。
注意:此字段可能返回 null,表示取不到有效值。
*/
Used?: number;
}
/**
* DeleteLoadBalancers返回参数结构体
*/
export interface DeleteLoadBalancersResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeRules请求参数结构体
*/
export interface DescribeRulesRequest {
/**
* 监听器 ID,格式为 lst- 后接 8 位字母数字。
*/
ListenerId: string;
/**
* 负载均衡实例 ID,格式为 alb- 后接 8 位字母数字。
*/
LoadBalancerId: string;
/**
* 支持的过滤条件如下:
*/
Filters?: Array<Filter>;
/**
* 返回列表的数量,默认为20,最大值为100。
*/
MaxResults?: number;
/**
* 下一次查询的Token值。第一次查询和没有下一次查询时,无需填写。如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。
*/
NextToken?: string;
/**
* 转发规则 ID 列表,ID 格式为 rule- 后接 8 位字母数字。
*/
RuleIds?: Array<string>;
}
/**
* HTTP Cookie信息
*/
export interface HTTPCookieInfo {
/**
* Cookie的键,长度1~64个字符,支持字母、数字、下划线。
*/
Key: string;
/**
* Cookie的值,长度1~128个字符,支持可打印字符。
*/
Value: string;
}
/**
* ModifySecurityPolicyAttributes请求参数结构体
*/
export interface ModifySecurityPolicyAttributesRequest {
/**
* <p>安全策略 ID,格式为 tls- 后接 8 位字母数字。</p>
*/
SecurityPolicyId: string;
/**
* <p>修改后的加密套件列表。加密套件用于协商客户端与服务端之间的加密算法。</p><p><strong>配置说明:</strong></p><ul><li>加密套件的可选范围取决于所选的 TLS 协议版本(TLSVersions 参数)。</li><li>只要加密套件被任意一个已选 TLS 版本支持,即可添加到列表中。</li><li>若 TLSVersions 包含 TLSv1.3:可不指定 TLSv1.3 专属加密套件(系统将自动补全全部 TLSv1.3 套件);若指定,则必须包含全部 TLSv1.3 专属加密套件,不支持仅指定部分。</li></ul><p><strong>获取可用加密套件:</strong><br>请调用 <a href="https://cloud.tencent.com/document/api/1822/133718">DescribeSecurityPolicyCapabilities</a> 接口查询各 TLS 版本支持的加密套件列表。</p><p><strong>注意:</strong> 若不传此参数,则保持原有配置不变。</p>
*/
Ciphers?: Array<string>;
/**
* <p>是否仅执行预检请求。取值:</p><ul><li><strong>true</strong>:仅执行预检请求,不实际修改资源。预检请求将验证参数格式、权限及配置有效性等,帮助您在正式操作前发现潜在问题。</li><li><strong>false</strong>(默认):执行正常请求,通过预检后将直接修改安全策略。</li></ul>
*/
DryRun?: boolean;
/**
* <p>修改后的安全策略名称。用于标识和区分不同的安全策略。</p><p><strong>命名规则:</strong></p><ul><li>长度为 2~128 个字符。</li><li>必须以英文字母或中文开头。</li><li>可包含英文字母、中文、数字、半角句号(.)、下划线(_)和短划线(-)。</li></ul><p><strong>注意:</strong> 若不传此参数,则保持原有名称不变。</p>
*/
SecurityPolicyName?: string;
/**
* <p>修改后的 TLS 协议版本列表。TLS(Transport Layer Security)协议用于保障客户端与负载均衡之间的通信安全。</p><p><strong>可选值:</strong></p><ul><li><strong>TLSv1.0</strong>:兼容性最好,但安全性较低,不推荐在生产环境使用。</li><li><strong>TLSv1.1</strong>:安全性略优于 TLSv1.0,但仍不推荐。</li><li><strong>TLSv1.2</strong>:目前主流的安全协议版本,兼顾安全性与兼容性。</li><li><strong>TLSv1.3</strong>:最新版本,安全性最高,性能更优,推荐优先使用。</li></ul><p><strong>注意:</strong> </p><ul><li>若不传此参数,则保持原有配置不变。</li><li>修改 TLS 版本时,请同步检查 Ciphers 参数的配置是否兼容。</li></ul>
*/
TLSVersions?: Array<string>;
}
/**
* DescribeSecurityPolicyRelations返回参数结构体
*/
export interface DescribeSecurityPolicyRelationsResponse {
/**
* 安全策略关联的监听器列表。返回每个安全策略所关联的 HTTPS 监听器信息。
*/
SecurityPolicyRelations?: Array<SecurityPolicyRelations>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeSecurityPolicies返回参数结构体
*/
export interface DescribeSecurityPoliciesResponse {
/**
* 下一页查询的起始令牌。
- 若返回值不为空,表示还有更多数据,可将此值作为下一次请求的 NextToken 参数继续查询。
- 若返回值为空或未返回此字段,表示已是最后一页。
*/
NextToken?: string;
/**
* 安全策略信息列表。包含每个安全策略的详细配置,如策略 ID、名称、TLS 版本、加密套件等。
*/
SecurityPolicies?: Array<SecurityPolicyInfo>;
/**
* 符合过滤条件的安全策略总数。
**说明:** 此值表示满足查询条件的总记录数,而非本次返回的记录数。可用于计算分页信息。
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* HTTP重定向信息
*/
export interface HTTPRedirectInfo {
/**
* <p>重定向的HTTP码,支持301、302、303、307、 308。</p>
*/
HttpCode: number;
/**
* <p>重定向的主机地址,默认值${host}。长度3 ~ 128个字符,支持的字符集为:a-z 0-9 _ . -。</p>
*/
Host?: string;
/**
* <p>重定向的路径,默认值${path}。长度1 ~ 128个字符,支持的字符集为:a-z A-Z 0-9 ? = _ . - / : 。</p>
*/
Path?: string;
/**
* <p>重定向的端口,默认值 ${port}。取值1 ~ 65535。</p>
*/
Port?: string;
/**
* <p>重定向的协议,取值:HTTP,HTTPS,默认值${protocol}。</p>
*/
Protocol?: string;
/**
* <p>重定向的查询字符串,默认值${query}。长度1 ~ 128字符,支持可打印字符,不支持 #[]{}|<>& 和空格。</p>
*/
Query?: string;
}
/**
* DescribeZones请求参数结构体
*/
export type DescribeZonesRequest = null;
/**
* 异步任务信息
*/
export interface Job {
/**
* 操作接口名称。
*/
ApiName?: string;
/**
* 任务流Id
*/
FlowId?: number;
/**
* 任务请求Id。
*/
RequestId?: string;
/**
* 资源ID列表
*/
ResourceIds?: Array<string>;
/**
* 任务状态。取值:Processing、Succeeded、Failed。
*/
Status?: string;
}
/**
* 关联监听器信息
*/
export interface RelatedListener {
/**
* 监听器 ID,格式为 lst- 后接 8 位字母数字。
*/
ListenerId?: string;
/**
* 监听器端口。
*/
ListenerPort?: number;
/**
* 监听器协议。
*/
ListenerProtocol?: string;
/**
* 负载均衡实例 ID,格式为 alb- 后接 8 位字母数字。
*/
LoadBalancerId?: string;
}
/**
* DescribeListenerCertificates请求参数结构体
*/
export interface DescribeListenerCertificatesRequest {
/**
* 证书类型。取值:CA或SVR(服务器证书)。
*/
CertificateType: string;
/**
* 监听器 ID,格式为 lst- 后接 8 位字母数字。
*/
ListenerId: string;
/**
* 负载均衡实例 ID,格式为 alb- 后接 8 位字母数字。
*/
LoadBalancerId: string;
/**
* 本次读取的最大数据记录数量。取值: 1~100。默认值: 20。
*/
MaxResults?: number;
/**
* 下一次查询的令牌(Token)。取值:
第一次查询和没有下一次查询时,均无需填写。
如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。
*/
NextToken?: string;
}
/**
* ModifyLoadBalancerAddressType请求参数结构体
*/
export interface ModifyLoadBalancerAddressTypeRequest {
/**
* 目标网络类型。取值:
- **Internet**(公网型)
负载均衡实例分配公网 IP 地址,域名(DNS)解析至公网 IP,可在公网环境中直接访问,适用于对外提供服务的业务场景。
- **Intranet**(内网型)
负载均衡实例仅分配私网 IP 地址,域名(DNS)解析至私网 IP,仅支持在负载均衡实例所属 VPC 内的内网环境访问,适用于内部业务或对安全性要求较高的场景。
*/
AddressType: string;
/**
* 负载均衡实例 ID,格式为 alb- 后接 8 位字母数字。
*/
LoadBalancerId: string;
/**
* 共享带宽包 ID。
*/
BandwidthPackageId?: string;
/**
* 是否只预检此次请求。取值:
- **true**:发送检查请求,不会更新实例的网络类型。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation。
- **false**(默认值):发送正常请求,通过检查后返回 HTTP 2xx 状态码并直接进行操作。
*/
DryRun?: boolean;
/**
* 可用区及子网映射结构体。
若当前地域支持 2 个及以上的可用区,至少需要添加 2 个可用区。
*/
ZoneMappings?: Array<ZoneMappingsItem>;
}
/**
* CreateRules返回参数结构体
*/
export interface CreateRulesResponse {
/**
* 转发规则 ID 列表,ID 格式为 rule- 后接 8 位字母数字。
*/
RuleIds?: Array<string>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateSecurityPolicy返回参数结构体
*/
export interface CreateSecurityPolicyResponse {
/**
* <p>安全策略 ID,格式为 tls- 后接 8 位字母数字。</p>
*/
SecurityPolicyId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteListener请求参数结构体
*/
export interface DeleteListenerRequest {
/**
* 监听器 ID 列表,ID 格式为 lst- 后接 8 位字母数字。
*/
ListenerIds: Array<string>;
/**
* 负载均衡实例 ID,格式为 alb- 后接 8 位字母数字。
*/
LoadBalancerId: string;
/**
* 客户端Token,用于保证请求的幂等性。
从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。
*/
ClientToken?: string;
}
/**
* ModifyTargetGroupAttributes返回参数结构体
*/
export interface ModifyTargetGroupAttributesResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 转发规则修改信息
*/
export interface RuleModify {
/**
* 转发规则动作列表。
*/
Actions?: Array<RuleAction>;
/**
* 转发规则条件列表。
*/
Conditions?: Array<RuleCondition>;
/**
* 优先级,值越小优先级越高,取值范围:1~10000。
*/
Priority?: number;
/**
* 转发规则 ID,格式为 rule- 后接 8 位字母数字。
*/
RuleId?: string;
/**
* 转发规则名称。
*/
RuleName?: string;
}
/**
* 会话保持配置。
*/
export interface StickySessionConfig {
/**
* 是否开启会话保持。
- **true**:开启。
- **false**:不开启。
注意:此字段可能返回 null,表示取不到有效值。
*/
StickySessionEnabled: boolean;
/**
* 自定义 Cookie 名称。
长度为 1~255 个字符,只能包含英文字母和数字字符,且不能为`tgw_l7_tg_route`,该字段为目标组间会话保持Cookie保留字段。
>仅当 **StickySessionEnabled** 为 **true** 时该参数生效。
*/
Cookie?: string;
/**
* 会话保持时间。
取值范围:**1-86400**,单位:**秒**。
默认值:**1000**。
>仅当 **StickySessionEnabled** 为 **true**时,该参数生效。
注意:此字段可能返回 null,表示取不到有效值。
*/
CookieTimeout?: number;
/**
* 会话保持类型(处理Cookie的方式)。
- **Insert**(默认值):植入 Cookie。 客户端第一次访问后端服务时,应用型负载均衡会在返回请求中植入 Cookie。下次客户端请求时携带该 Cookie,负载均衡将请求转发到上次请求的相同后端服务。
- **Rewrite**:重写 Cookie。 负载均衡会对用户自定义的 Cookie 进行重写,下次客户端请求时携带该 Cookie,负载均衡将请求转发到上次请求的相同后端服务。
>仅当 **StickySessionEnabled** 为 **true** 时该参数生效。
注意:此字段可能返回 null,表示取不到有效值。
*/
StickySessionType?: string;
}
/**
* AssociateListenerAdditionalCertificates返回参数结构体
*/
export interface AssociateListenerAdditionalCertificatesResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 监听器简要信息出参
*/
export interface ListenerOutput {
/**
* 是否开启双向认证。
*/
CaEnable?: boolean;
/**
* 监听器实例的创建时间。格式:ISO 8601(例如 2025-01-01T08:30:00+08:00)
*/
CreateTime?: string;
/**
* 是否启用 Gzip 压缩。
*/
GzipEnabled?: boolean;
/**
* 是否启用http2。
*/
Http2Enable?: boolean;
/**
* 空闲超时时间。
*/
IdleTimeout?: number;
/**
* 监听器 ID,格式为 lst- 后接 8 位字母数字。
*/
ListenerId?: string;
/**
* 监听器名称。
*/
ListenerName?: string;
/**
* 监听器端口。
*/
ListenerPort?: number;
/**
* 监听器协议。
*/
ListenerProtocol?: string;
/**
* 监听器状态。取值:=
- **Active**: 运行中。
- **Provisioning**:创建中。
- **Configuring**:变配中。
- **ProvisionFailed**:创建失败
*/
ListenerStatus?: string;
/**
* 监听器实例的最后变更时间。格式:ISO 8601(例如 2025-01-01T08:30:00+08:00)
*/
ModifyTime?: string;
/**
* 请求超时时间。
*/
RequestTimeout?: number;
/**
* 标签。
*/
Tags?: Array<TagInfo>;
/**
* 安全策略 ID。
*/
TlsSecurityPolicyId?: string;
/**
* XForwardedFor配置。
*/
XForwardedForConfig?: XForwardedForConfig;
}
/**
* 描述了后付费计费项的价格信息
*/
export interface PostPayPriceInfo {
/**
* 折扣,如20.0代表2折。
注意:此字段可能返回 null,表示取不到有效值。
*/
Discount?: number;
/**
* 单价,单位:元。
注意:此字段可能返回 null,表示取不到有效值。
*/
UnitPrice?: number;
/**
* 折扣单价,单位:元。
注意:此字段可能返回 null,表示取不到有效值。
*/
UnitPriceDiscount?: number;
}
/**
* CreateRules请求参数结构体
*/
export interface CreateRulesRequest {
/**
* 监听器 ID,格式为 lst- 后接 8 位字母数字。
*/
ListenerId: string;
/**
* 负载均衡实例 ID,格式为 alb- 后接 8 位字母数字。
*/
LoadBalancerId: string;
/**
* 转发规则列表。
*/
Rules: Array<RuleInput>;
/**
* 客户端Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。
*/
ClientToken?: string;
/**
* 是否只预检查此次请求。
*/
DryRun?: boolean;
}
/**
* DeleteSecurityPolicy返回参数结构体
*/
export interface DeleteSecurityPolicyResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 添加至目标组的后端服务
*/
export interface TargetToAdd {
/**
* 后端服务器使用的端口。取值范围:**1 - 65535**。
>当目标组的 **targetType** 取值为 **Instance** 时,该参数必传。
*/
Port: number;
/**
* 后端服务IP。**TargetIp**和**TargetId**需要至少传一个。
- 当服务器组为 **Instance** 类型时,该参数为 **Eni** 的主内网 IP 或辅助内网 IP。
*/
TargetIp: string;
/**
* 后端服务的权重,取值范围:**0 - 100**。默认值为**10**。如果设置权重为**0**,则不会将请求转发给该后端服务。
*/
Weight?: number;
}
/**
* DisassociateListenerAdditionalCertificates返回参数结构体
*/
export interface DisassociateListenerAdditionalCertificatesResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeSecurityPolicyCapabilities返回参数结构体
*/
export interface DescribeSecurityPolicyCapabilitiesResponse {
/**
* 安全策略配置能力列表。返回当前地域支持的所有 TLS 版本及其对应的加密套件信息。
**返回内容包含:**
- 支持的 TLS 协议版本(如 TLSv1.0、TLSv1.1、TLSv1.2、TLSv1.3)。
- 每个 TLS 版本支持的加密套件列表。
**使用场景:**
- 在创建安全策略(CreateSecurityPolicy)前,调用此接口获取可选的加密套件。
- 在修改安全策略(ModifySecurityPolicyAttributes)前,确认新配置的有效性。
*/
SecurityPolicyCapabilities?: Array<SecurityPolicyCapability>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 删除HTTP Header信息
*/
export interface RemoveHTTPHeaderInfo {
/**
* 要删除的HTTP Header的键,长度1 ~ 40个字符,支持的字符集为:a-z A-Z 0-9 - _ 。
不支持Cookie,Host,Content-Length,Connection,Upgrade,transfer-encoding,keep-alive,te,authority,x-forwarded-for,x-forwarded-proto,x-forwarded-host,x-forwarded-port,server
*/
Key: string;
}
/**
* DescribeTargetGroupTargets请求参数结构体
*/
export interface DescribeTargetGroupTargetsRequest {
/**
* 目标组 ID,格式为 lbtg- 后接 8 位字母数字。
*/
TargetGroupId: string;
/**
* 过滤器。通过指定的过滤条件来查询后端服务,支持:
- Name的值为**TargetId**。通过资源ID来筛选后端服务,当目标组后端类型为**Instance**时生效。**Values**的值为Cvm或Eni的资源ID。
- Name的值为**TargetIp**。通过资源IP来筛选后端服务,当目标组后端类型为**Ip**时生效。**Values**的值为后端服务的IP。
- 通过标签方式筛选。
*/
Filters?: Array<Filter>;
/**
* 返回列表的数量,默认为**20**,最大值为**100**。
*/
MaxResults?: number;
/**
* 下一次查询的Token值。第一次查询和没有下一次查询时,无需填写。
如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。
*/
NextToken?: string;
}
/**
* DescribeListenerCertificates返回参数结构体
*/
export interface DescribeListenerCertificatesResponse {
/**
* 监听器绑定的证书信息列表。
*/
Certificates?: Array<CertificateInfo>;
/**
* 本次读取的最大数据记录数量。
*/
MaxResults?: number;
/**
* 下一次查询的令牌。
注意:此字段可能返回 null,表示取不到有效值。
*/
NextToken?: string;
/**
* 监听器绑定的证书总量。
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* SetLoadBalancerSecurityGroups请求参数结构体
*/
export interface SetLoadBalancerSecurityGroupsRequest {
/**
* 负载均衡实例 ID,格式为 alb- 后接 8 位字母数字。
*/
LoadBalancerId: string;
/**
* 安全组 ID 列表。
*/
SecurityGroups: Array<string>;
}
/**
* RemoveTargetsFromTargetGroup返回参数结构体
*/
export interface RemoveTargetsFromTargetGroupResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AddTargetsToTargetGroup返回参数结构体
*/
export interface AddTargetsToTargetGroupResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeAsyncJobs请求参数结构体
*/
export interface DescribeAsyncJobsRequest {
/**
* 分批次查询时每次显示的条目数。取值范围:1~100,默认值:20。
*/
MaxResults?: number;
/**
* 是否拥有下一次查询的令牌(Token)。取值: 第一次查询和没有下一次查询时,均无需填写。 如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。
*/
NextToken?: string;
/**
* 异步请求返回的RequestId列表
*/
RequestIds?: Array<string>;
}
/**
* CreateListener返回参数结构体
*/
export interface CreateListenerResponse {
/**
* 监听器 ID,格式为 lst- 后接 8 位字母数字。
*/
ListenerId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateTargetGroup返回参数结构体
*/
export interface CreateTargetGroupResponse {
/**
* <p>目标组 ID,格式为 lbtg- 后接 8 位字母数字。</p>
*/
TargetGroupId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 目标组配置
*/
export interface TargetGroupConfig {
/**
* 目标组列表。
*/
TargetGroups: Array<TargetGroupTuple>;
/**
* 目标组间会话保持
*/
TargetGroupStickySession?: TargetGroupStickySession;
}
/**
* DescribeTargetGroupsByTarget请求参数结构体
*/
export interface DescribeTargetGroupsByTargetRequest {
/**
* 后端服务实例 ID,CVM 实例格式为 ins- 后接 8 位字母数字。
*/
TargetId?: Array<string>;
}
/**
* 目标组之间会话保持
*/
export interface TargetGroupStickySession {
/**
* 是否开启会话保持,默认关闭。
*/
Enabled: boolean;
/**
* 超时时间,单位秒,取值范围:1~86400,默认值:1000。
*/
Timeout?: number;
}
/**
* DeleteLoadBalancers请求参数结构体
*/
export interface DeleteLoadBalancersRequest {
/**
* 负载均衡实例 ID 列表,ID 格式为 alb- 后接 8 位字母数字。
*/
LoadBalancerIds: Array<string>;
/**
* 客户端Token,用于保证请求的幂等性。
从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。
*/
ClientToken?: string;
/**
* 是否只预检此次请求,取值:
- **true**:发送检查请求,不会删除应用型负载均衡实例。检查项包括是否填写了必需参数、请求格式和业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。
- **false**(默认值):发送正常请求,通过检查后返回`HTTP 2xx`状态码并直接进行操作。
*/
DryRun?: boolean;
}
/**
* 转发规则条件
*/
export interface RuleCondition {
/**
* 转发条件类型。取值:
Host:主机。
Path:路径。
Header:HTTP Header字段。
QueryString:HTPP查询字符串。
Method:请求方法。
Cookie:Cookie。
SourceIp:源 IP。
*/
Type: string;
/**
* Cookie配置。
*/
CookieConfig?: Array<HTTPCookieInfo>;
/**
* HTTP Header配置。
*/
HeaderConfig?: HTTPHeaderInfo;
/**
* 主机名。主机配置在一个规则中只能出现一次,长度3 ~ 128个字符,支持精确匹配,正则匹配,通配匹配。
不能以半角句号(.)、下划线(_)开头或结尾。
精确匹配,支持的字符集为:a-z 0-9 . - _ 。
正则匹配,波浪线(~)开头为正则匹配,支持的字符集为:a-z 0-9 . - ? = ~ _ - + \ ^ * ! $ & | ( ) [ ] 。
通配匹配,星号(*)多字符通配,半角问号(?)单字符通配,支持的字符集为:a-z 0-9 . - _ * ?。
*/
HostConfig?: Array<string>;
/**
* 请求方法。取值:HEAD、GET、POST、OPTIONS、PUT、PATCH、DELETE。
*/
MethodConfig?: Array<string>;
/**
* 转发路径。长度1 ~ 128个字符,支持精确匹配,正则匹配,通配匹配。
精确匹配,支持的字符集为:a-z A-Z 0-9 . - _ / = :。
正则匹配,需以 ~ 开头,~ 开头表示区分大小写, ~* 开头表示不区分大小写,支持的字符集为: a-z A-Z 0-9 . - _ / = ? ~ ^ * $ : ( ) [ ] + |。
通配匹配,* 表示多字符通配,? 表示单字符通配,支持的字符集为:a-z A-Z 0-9 . - _ / = :。
*/
PathConfig?: Array<string>;
/**
* 查询字符串配置。
*/
QueryStringConfig?: Array<HTTPQueryStringInfo>;
/**
* 源IP匹配配置。CIDR格式,IP地址x.x.x.x/32,IP网段x.x.x.x/24。
*/
SourceIpConfig?: Array<string>;
}
/**
* 可用区信息
*/
export interface Zone {
/**
* 可用区名称
*/
LocalName?: string;
/**
* 可用区 ID
*/
ZoneId?: string;
/**
* 可用区状态
*/
ZoneStatus?: string;
}
/**
* 转发规则信息
*/
export interface RuleOutput {
/**
* 转发规则动作列表。
*/
Actions?: Array<RuleAction>;
/**
* 转发规则条件列表。
*/
Conditions?: Array<RuleCondition>;
/**
* 创建时间。
*/
CreateTime?: string;
/**
* 转发规则的方向。Request:客户端到负载均衡的请求方向,Response:后端服务器到负载均衡的响应方向。
*/
Direction?: string;
/**
* 最后修改时间。
*/
ModifyTime?: string;
/**
* 优先级,值越小优先级越高,取值范围:1~10000。
*/
Priority?: number;
/**
* 转发规则 ID,格式为 rule- 后接 8 位字母数字。
*/
RuleId?: string;
/**
* 转发规则名称。
*/
RuleName?: string;
/**
* 转发规则状态,Provisioning:创建中,Active:运行中,Configuring:配置中。
*/
Status?: string;
/**
* 标签列表。
*/
Tags?: Array<TagInfo>;
}
/**
* 不同TLS版本支持的加密套件信息。
*/
export interface SecurityPolicyCapability {
/**
* 支持的加密套件列表。
*/
Ciphers?: Array<string>;
/**
* 支持的 TLS 协议版本。可选值包括:TLSv1.0、TLSv1.1、TLSv1.2、TLSv1.3。
*/
TLSVersion?: string;
}
/**
* 修改保护状态信息。
*/
export interface ModificationProtectionInfo {
/**
* 是否开启修改保护。开启后,可防止实例被意外修改或删除。
- true:开启修改保护
- false:关闭修改保护
*/
ModificationProtectionEnabled?: boolean;
/**
* 1238716123
*/
OperatorUin?: string;
/**
* 开启修改保护的原因说明。
长度为 1~255 个字符,必须是中文和无害字符串中的字符, 可包含中文、字母、数字、短划线(-)、正斜线(/)、半角句号(.)、下划线(_)。
*/
Reason?: string;
}
/**
* ModifyTargetsInTargetGroup返回参数结构体
*/
export interface ModifyTargetsInTargetGroupResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifySecurityPolicyAttributes返回参数结构体
*/
export interface ModifySecurityPolicyAttributesResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteSecurityPolicy请求参数结构体
*/
export interface DeleteSecurityPolicyRequest {
/**
* 安全策略 ID 列表,ID 格式为 tls- 后接 8 位字母数字。
*/
SecurityPolicyIds: Array<string>;
/**
* 是否仅执行预检请求。取值:
- **true**:仅执行预检请求,不实际删除资源。预检请求将验证参数格式、权限及安全策略是否被引用等,帮助您在正式操作前发现潜在问题。
- **false**(默认):执行正常请求,通过预检后将直接删除安全策略。
*/
DryRun?: boolean;
}
/**
* 规则健康检查状态
*/
export interface RuleHealthStatusInfo {
/**
* 是否为默认转发规则。
*/
IsDefaultRule?: string;
/**
* 转发规则 ID,格式为 rule- 后接 8 位字母数字。
*/
RuleId?: string;
/**
* 目标组健康状态。
*/
TargetGroupHealthInfos?: Array<TargetGroupHealthInfo>;
}
/**
* ModifyLoadBalancerAddre