{ "name": "clb", "display_name": "负载均衡", "description": "介绍如何使用API对负载均衡进行操作，包括创建、查询负载均衡实例、管理监听等。", "domain": "network", "api_version": "2018-03-17", "endpoint": "clb.tencentcloudapi.com", "actions": [ { "name": "AssociateCustomizedConfig", "description": "关联配置到server或location，根据配置类型关联到server或location。准备下线，请使用SetCustomizedConfigForLoadBalancer。", "status": "online", "parameters": [ { "name": "UconfigId", "type": "string", "required": true, "description": "配置ID", "example": "pz-clweh**c1" }, { "name": "BindList", "type": "array", "required": true, "description": "关联的server或location", "example": "无", "item_type": "object", "children": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "配置绑定的CLB ID", "example": "lb-6e6a****" }, { "name": "ListenerId", "type": "string", "required": true, "description": "配置绑定的监听器ID", "example": "lbl-cuxw****" }, { "name": "Domain", "type": "string", "required": true, "description": "配置绑定的域名", "example": "www.test.com" }, { "name": "LocationId", "type": "string", "required": false, "description": "配置绑定的规则", "example": "loc-4apy****" } ] } ], "required": [ "UconfigId", "BindList" ] }, { "name": "AssociateTargetGroups", "description": "本接口(AssociateTargetGroups)用来将目标组绑定到负载均衡的监听器（四层协议）或转发规则（七层协议）上。 本接口为异步接口，本接口返回成功后需以返回的 RequestID 为入参，调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。 限制说明： - 四层监听器绑定旧版目标组需要监听器开启后端目标组。 - 七层绑定目标组，数据结构 TargetGroupAsso...", "status": "online", "parameters": [ { "name": "Associations", "type": "array", "required": true, "description": "绑定的关系数组，目标组类型需要一致。 一次请求最多支持20个。", "example": "无", "item_type": "object", "children": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡ID", "example": "lb-agcadfe" }, { "name": "TargetGroupId", "type": "string", "required": true, "description": "目标组ID", "example": "lbtg-0nzo3czo" }, { "name": "ListenerId", "type": "string", "required": false, "description": "监听器ID。访问AssociateTargetGroups和DisassociateTargetGroups接口时必传此参数。", "example": "lbl-xxxx" }, { "name": "LocationId", "type": "string", "required": false, "description": "转发规则ID", "example": "loc-aaaaaa" }, { "name": "Weight", "type": "integer", "required": false, "description": "目标组权重，范围[0, 100]。仅绑定v2目标组时生效，如果不存在，则默认为10。", "example": "100" } ] } ], "required": [ "Associations" ] }, { "name": "AutoRewrite", "description": "用户需要先创建出一个HTTPS:443监听器，并在其下创建转发规则。通过调用本接口，系统会自动创建出一个HTTP:80监听器（如果之前不存在），并在其下创建转发规则，与HTTPS:443监听器下的Domains（在入参中指定）对应。创建成功后可以通过HTTP:80地址自动跳转为HTTPS:443地址进行访问。 本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次\ufffd...", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例ID。", "example": "lb-r6nx1iby" }, { "name": "ListenerId", "type": "string", "required": true, "description": "HTTPS:443监听器的ID。", "example": "lbl-lmeeyb1q" }, { "name": "Domains", "type": "array", "required": false, "description": "HTTPS:443监听器下需要重定向的域名，若不填，则对HTTPS:443监听器下的所有域名都设置重定向。", "example": "[\"www.abc.com\\n\"]", "item_type": "string" }, { "name": "RewriteCodes", "type": "array", "required": false, "description": "重定向状态码，可取值301,302,307。", "example": "301", "item_type": "integer" }, { "name": "TakeUrls", "type": "array", "required": false, "description": "重定向是否携带匹配的URL。", "example": "true", "item_type": "boolean" } ], "required": [ "LoadBalancerId", "ListenerId" ] }, { "name": "BatchDeregisterTargets", "description": "批量解绑四七层后端服务。批量解绑的资源数量上限为500。只支持VPC网络负载均衡。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡ID。", "example": "lb-xxxx" }, { "name": "Targets", "type": "array", "required": true, "description": "解绑目标。", "example": "无", "item_type": "object", "children": [ { "name": "ListenerId", "type": "string", "required": true, "description": "监听器 ID。", "example": "lbl-2gas****" }, { "name": "Port", "type": "integer", "required": true, "description": "绑定端口。", "example": "80" }, { "name": "InstanceId", "type": "string", "required": false, "description": "子机 ID。表示绑定主网卡主 IP。", "example": "ins-1vfj****" }, { "name": "EniIp", "type": "string", "required": false, "description": "绑定 IP 时需要传入此参数，支持弹性网卡的 IP 和其他内网 IP，如果是弹性网卡则必须先绑定至CVM，然后才能绑定到负载均衡实例。 注意：参数 InstanceId、EniIp 只能传入一个且必须传入一个。如果绑定双栈IPV6子机，必须传该参数。", "example": "10.0.X.X" }, { "name": "Weight", "type": "integer", "required": false, "description": "子机权重，范围[0, 100]。绑定时如果不存在，则默认为10。", "example": "10" }, { "name": "LocationId", "type": "string", "required": false, "description": "七层规则 ID。7层负载均衡该参数必填", "example": "loc-4apy****" }, { "name": "Tag", "type": "string", "required": false, "description": "标签。", "example": "tag_target" } ] } ], "required": [ "LoadBalancerId", "Targets" ] }, { "name": "BatchModifyTargetTag", "description": "BatchModifyTargetTag 接口用于批量修改负载均衡监听器绑定的后端机器的标签。批量修改的资源数量上限为500。本接口为同步接口。负载均衡的4层和7层监听器支持此接口，传统型负载均衡不支持。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例 ID。", "example": "lb-dx98lwo0" }, { "name": "ModifyList", "type": "array", "required": true, "description": "要批量修改标签的列表。", "example": "无", "item_type": "object", "children": [ { "name": "ListenerId", "type": "string", "required": true, "description": "负载均衡监听器 ID。", "example": "lbl-cuxw****" }, { "name": "Targets", "type": "array", "required": true, "description": "要修改标签的后端机器列表。", "example": "无", "item_type": "object", "children": [ { "name": "Port", "type": "integer", "required": true, "description": "后端服务的监听端口。 注意：绑定CVM（云服务器）或ENI（弹性网卡）时必传此参数", "example": "80" }, { "name": "Type", "type": "string", "required": false, "description": "后端服务的类型，可取：CVM（云服务器）、ENI（弹性网卡）；作为入参时，目前本参数暂不生效。", "example": "CVM" }, { "name": "InstanceId", "type": "string", "required": false, "description": "绑定CVM时需要传入此参数，代表CVM的唯一 ID，可通过 DescribeInstances 接口返回字段中的 InstanceId 字段获取。表示绑定主网卡主IPv4地址；以下场景都不支持指定InstanceId：绑定非CVM，绑定CVM上的辅助网卡IP，通过跨域2.0绑定CVM，以及绑定CVM的IPv6地址等。 注意：参数 InstanceId、EniIp 有且只能传入其中一个参数。", "example": "ins-xxxxxxxx" }, { "name": "Weight", "type": "integer", "required": false, "description": "后端服务修改后的转发权重，取值范围：[0, 100]，默认为 10。此参数的优先级高于[RsWeightRule](https://cloud.tencent.com/document/api/214/30694#RsWeightRule)中的Weight参数，即最终的权重值以此Weight参数值为准，仅当此Weight参数为空时，才以RsWeightRule中的Weight参数为准。", "example": "10" }, { "name": "EniIp", "type": "string", "required": false, "description": "绑定IP时需要传入此参数，支持弹性网卡的IP和其他内网IP，如果是弹性网卡则必须先绑定至CVM，然后才能绑定到负载均衡实例。 注意：参数 InstanceId、EniIp 有且只能传入其中一个参数。如果绑定双栈IPV6子机，则必须传该参数。如果是跨地域绑定，则必须传该参数，不支持传InstanceId参数。", "example": "x.x.x.x" }, { "name": "Tag", "type": "string", "required": false, "description": "标签。", "example": "tag_taget" } ] }, { "name": "LocationId", "type": "string", "required": false, "description": "转发规则的ID，七层规则时需要此参数，4层规则不需要。", "example": "loc-o8cn****" }, { "name": "Tag", "type": "string", "required": false, "description": "后端服务修改后的标签。此参数的优先级低于前述Target中的Tag参数，即最终的标签以Target中的Tag参数值为准，仅当Target中的Tag参数为空时，才以RsTagRule中的Tag参数为准。", "example": "tag_target" } ] } ], "required": [ "LoadBalancerId", "ModifyList" ] }, { "name": "BatchModifyTargetWeight", "description": "BatchModifyTargetWeight 接口用于批量修改负载均衡监听器绑定的后端机器的转发权重。批量修改的资源数量上限为500。本接口为异步接口，本接口返回成功后需以返回的 RequestID 为入参，调用 DescribeTaskStatus 接口查询本次任务是否成功。负载均衡的4层和7层监听器支持此接口，传统型负载均衡不支持。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例 ID。", "example": "lb-dx98lwo0" }, { "name": "ModifyList", "type": "array", "required": true, "description": "要批量修改权重的列表。", "example": "无", "item_type": "object", "children": [ { "name": "ListenerId", "type": "string", "required": true, "description": "负载均衡监听器 ID。", "example": "lb-cuxw****" }, { "name": "Targets", "type": "array", "required": true, "description": "要修改权重的后端机器列表。", "example": "无", "item_type": "object", "children": [ { "name": "Port", "type": "integer", "required": true, "description": "后端服务的监听端口。 注意：绑定CVM（云服务器）或ENI（弹性网卡）时必传此参数", "example": "80" }, { "name": "Type", "type": "string", "required": false, "description": "后端服务的类型，可取：CVM（云服务器）、ENI（弹性网卡）；作为入参时，目前本参数暂不生效。", "example": "CVM" }, { "name": "InstanceId", "type": "string", "required": false, "description": "绑定CVM时需要传入此参数，代表CVM的唯一 ID，可通过 DescribeInstances 接口返回字段中的 InstanceId 字段获取。表示绑定主网卡主IPv4地址；以下场景都不支持指定InstanceId：绑定非CVM，绑定CVM上的辅助网卡IP，通过跨域2.0绑定CVM，以及绑定CVM的IPv6地址等。 注意：参数 InstanceId、EniIp 有且只能传入其中一个参数。", "example": "ins-xxxxxxxx" }, { "name": "Weight", "type": "integer", "required": false, "description": "后端服务修改后的转发权重，取值范围：[0, 100]，默认为 10。此参数的优先级高于[RsWeightRule](https://cloud.tencent.com/document/api/214/30694#RsWeightRule)中的Weight参数，即最终的权重值以此Weight参数值为准，仅当此Weight参数为空时，才以RsWeightRule中的Weight参数为准。", "example": "10" }, { "name": "EniIp", "type": "string", "required": false, "description": "绑定IP时需要传入此参数，支持弹性网卡的IP和其他内网IP，如果是弹性网卡则必须先绑定至CVM，然后才能绑定到负载均衡实例。 注意：参数 InstanceId、EniIp 有且只能传入其中一个参数。如果绑定双栈IPV6子机，则必须传该参数。如果是跨地域绑定，则必须传该参数，不支持传InstanceId参数。", "example": "x.x.x.x" }, { "name": "Tag", "type": "string", "required": false, "description": "标签。", "example": "tag_taget" } ] }, { "name": "LocationId", "type": "string", "required": false, "description": "转发规则的ID，七层规则时需要此参数，4层规则不需要。", "example": "loc-o8cn****" }, { "name": "Weight", "type": "integer", "required": false, "description": "后端服务修改后的转发权重，取值范围：[0，100]。此参数的优先级低于前述[Target](https://cloud.tencent.com/document/api/214/30694#Target)中的Weight参数，即最终的权重值以Target中的Weight参数值为准，仅当Target中的Weight参数为空时，才以RsWeightRule中的Weight参数为准。", "example": "10" } ] } ], "required": [ "LoadBalancerId", "ModifyList" ] }, { "name": "BatchRegisterTargets", "description": "批量绑定虚拟主机或弹性网卡，支持跨域绑定，支持四层、七层（TCP、UDP、HTTP、HTTPS）协议绑定。批量绑定的资源数量上限为500。只支持VPC网络负载均衡。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡ID。", "example": "lb-xxxx" }, { "name": "Targets", "type": "array", "required": true, "description": "绑定目标。", "example": "无", "item_type": "object", "children": [ { "name": "ListenerId", "type": "string", "required": true, "description": "监听器 ID。", "example": "lbl-2gas****" }, { "name": "Port", "type": "integer", "required": true, "description": "绑定端口。", "example": "80" }, { "name": "InstanceId", "type": "string", "required": false, "description": "子机 ID。表示绑定主网卡主 IP。", "example": "ins-1vfj****" }, { "name": "EniIp", "type": "string", "required": false, "description": "绑定 IP 时需要传入此参数，支持弹性网卡的 IP 和其他内网 IP，如果是弹性网卡则必须先绑定至CVM，然后才能绑定到负载均衡实例。 注意：参数 InstanceId、EniIp 只能传入一个且必须传入一个。如果绑定双栈IPV6子机，必须传该参数。", "example": "10.0.X.X" }, { "name": "Weight", "type": "integer", "required": false, "description": "子机权重，范围[0, 100]。绑定时如果不存在，则默认为10。", "example": "10" }, { "name": "LocationId", "type": "string", "required": false, "description": "七层规则 ID。7层负载均衡该参数必填", "example": "loc-4apy****" }, { "name": "Tag", "type": "string", "required": false, "description": "标签。", "example": "tag_target" } ] } ], "required": [ "LoadBalancerId", "Targets" ] }, { "name": "CloneLoadBalancer", "description": "克隆负载均衡实例，根据指定的负载均衡实例，复制出相同规则和绑定关系的负载均衡实例。克隆接口为异步操作，克隆的数据以调用CloneLoadBalancer时为准，如果调用CloneLoadBalancer后克隆CLB发生变化，变化规则不会克隆。 注：查询实例创建状态可以根据返回值中的requestId访问[DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683)接口 限制说明 实例属性维度限制： - 支持克隆\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡ID，可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。", "example": "lb-5luefaho" }, { "name": "LoadBalancerName", "type": "string", "required": false, "description": "克隆出负载均衡实例的名称，规则：1-60 个英文、汉字、数字、连接线“-”或下划线“_”。 注意：如果名称与系统中已有负载均衡实例的名称相同，则系统将会自动生成此次创建的负载均衡实例的名称。", "example": "test-name" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "负载均衡实例所属的项目 ID，默认项目 ID 为0，可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。不传此参数则视为默认项目。", "example": "0" }, { "name": "MasterZoneId", "type": "string", "required": false, "description": "仅适用于公网负载均衡。设置跨可用区容灾时的主可用区ID，可用区 ID 和名称均支持，例如 100001 或 ap-guangzhou-1。 注：主可用区是需要承载流量的可用区，备可用区默认不承载流量，主可用区不可用时才使用备可用区，平台将为您自动选择最佳备可用区。可通过 [DescribeResources](https://cloud.tencent.com/document/api/214/70213) 接口查询一个地域的主可用区的列表。", "example": "ap-guangzhou-1" }, { "name": "SlaveZoneId", "type": "string", "required": false, "description": "仅适用于公网负载均衡。设置跨可用区容灾时的备可用区ID，可用区 ID 和名称均支持，例如 100001 或 ap-guangzhou-1。 注：备可用区是主可用区故障后，需要承载流量的可用区。可通过 [DescribeResources](https://cloud.tencent.com/document/api/214/70213) 接口查询一个地域的主/备可用区的列表。", "example": "ap-guangzhou-1" }, { "name": "ZoneId", "type": "string", "required": false, "description": "仅适用于公网负载均衡。可用区ID，可用区 ID 和名称均支持，指定可用区以创建负载均衡实例。如：100001 或 ap-guangzhou-1。不传则查询所有可用区的 CVM 实例。如需指定可用区，可调用查询可用区列表 [DescribeZones](https://cloud.tencent.com/document/product/213/15707) 接口查询。", "example": "ap-guangzhou-1" }, { "name": "InternetAccessible", "type": "object", "required": false, "description": "仅适用于公网负载均衡。负载均衡的网络计费模式。", "example": "无", "children": [ { "name": "InternetChargeType", "type": "string", "required": false, "description": "TRAFFIC_POSTPAID_BY_HOUR 按流量按小时后计费 ; BANDWIDTH_POSTPAID_BY_HOUR 按带宽按小时后计费，国际站用户不支持该计费模式; BANDWIDTH_PACKAGE 按带宽包计费;BANDWIDTH_PREPAID按带宽预付费。", "example": "BANDWIDTH_POSTPAID_BY_HOUR" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "最大出带宽，单位Mbps，仅对公网属性的共享型、性能容量型和独占型 CLB 实例、以及内网属性的性能容量型 CLB 实例生效。 - 对于公网属性的共享型和独占型 CLB 实例，最大出带宽的范围为1Mbps-2048Mbps。 - 对于公网属性和内网属性的性能容量型 CLB实例，最大出带宽的范围为1Mbps-61440Mbps。 （调用CreateLoadBalancer创建LB时不指定此参数则设置为默认值10Mbps。此上限可调整）", "example": "1" }, { "name": "BandwidthpkgSubType", "type": "string", "required": false, "description": "带宽包的类型，如 BGP（多线）。 类型如下： SINGLEISP: 单线 BGP: 多线 HIGH_QUALITY_BGP: 精品BGP共享带宽包 SINGLEISP_CMCC: 中国移动共享带宽包 SINGLEISP_CTCC: 中国电信共享带宽包 SINGLEISP_CUCC: 中国联通共享带宽包 注意：此字段可能返回 null，表示取不到有效值。", "example": "SINGLEISP" } ] }, { "name": "VipIsp", "type": "string", "required": false, "description": "仅适用于公网负载均衡。目前仅广州、上海、南京、济南、杭州、福州、北京、石家庄、武汉、长沙、成都、重庆地域支持静态单线 IP 线路类型，如需体验，请联系商务经理申请。申请通过后，即可选择中国移动（CMCC）、中国联通（CUCC）或中国电信（CTCC）的运营商类型，网络计费模式只能使用按带宽包计费(BANDWIDTH_PACKAGE)。 如果不指定本参数，则默认使用BGP。可通过 DescribeRe...", "example": "CMCC" }, { "name": "Vip", "type": "string", "required": false, "description": "指定Vip申请负载均衡。", "example": "139.X.X.X" }, { "name": "Tags", "type": "array", "required": false, "description": "购买负载均衡同时，给负载均衡打上标签。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签的键", "example": "key-xxx" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签的值", "example": "value-xxx" } ] }, { "name": "ExclusiveCluster", "type": "object", "required": false, "description": "独占集群信息。", "example": "无", "children": [ { "name": "L4Clusters", "type": "array", "required": false, "description": "4层独占集群列表 注意：此字段可能返回 null，表示取不到有效值。", "item_type": "object", "children": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群唯一ID", "example": "tgw-p1zxs4fu" }, { "name": "ClusterName", "type": "string", "required": false, "description": "集群名称", "example": "guangzhou-zone4-M6-S4-40G-CAP-CLB-TPNS-SET1" }, { "name": "Zone", "type": "string", "required": false, "description": "集群所在可用区，如ap-guangzhou-1 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-guangzhou-1" } ] }, { "name": "L7Clusters", "type": "array", "required": false, "description": "7层独占集群列表 注意：此字段可能返回 null，表示取不到有效值。", "item_type": "object", "children": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群唯一ID", "example": "tgw-p1zxs4fu" }, { "name": "ClusterName", "type": "string", "required": false, "description": "集群名称", "example": "guangzhou-zone4-M6-S4-40G-CAP-CLB-TPNS-SET1" }, { "name": "Zone", "type": "string", "required": false, "description": "集群所在可用区，如ap-guangzhou-1 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-guangzhou-1" } ] }, { "name": "ClassicalCluster", "type": "object", "required": false, "description": "vpcgw集群 注意：此字段可能返回 null，表示取不到有效值。", "children": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群唯一ID", "example": "tgw-p1zxs4fu" }, { "name": "ClusterName", "type": "string", "required": false, "description": "集群名称", "example": "guangzhou-zone4-M6-S4-40G-CAP-CLB-TPNS-SET1" }, { "name": "Zone", "type": "string", "required": false, "description": "集群所在可用区，如ap-guangzhou-1 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-guangzhou-1" } ] } ] }, { "name": "BandwidthPackageId", "type": "string", "required": false, "description": "带宽包ID，可以通过 [DescribeBandwidthPackages](https://cloud.tencent.com/document/api/215/19209) 接口获取。指定此参数时，网络计费方式（InternetAccessible.InternetChargeType）只支持按带宽包计费（BANDWIDTH_PACKAGE）。", "example": "bwp-pnbe****" }, { "name": "SnatPro", "type": "boolean", "required": false, "description": "是否支持绑定跨地域/跨Vpc绑定IP的功能。", "example": "true" }, { "name": "SnatIps", "type": "array", "required": false, "description": "开启绑定跨地域/跨Vpc绑定IP的功能后，创建SnatIp。", "example": "无", "item_type": "object", "children": [ { "name": "SubnetId", "type": "string", "required": true, "description": "私有网络子网的唯一性id，如subnet-12345678", "example": "subnet-3152159" }, { "name": "Ip", "type": "string", "required": false, "description": "IP地址，如192.168.0.1", "example": "192.168.0.1" } ] }, { "name": "ClusterIds", "type": "array", "required": false, "description": "公网独占集群ID或者CDCId，可以通过 [DescribeExclusiveClusters](https://cloud.tencent.com/document/product/214/49278) 接口获取。", "example": "[\"cluster-gbo2****\"]", "item_type": "string" }, { "name": "SlaType", "type": "string", "required": false, "description": "性能容量型规格。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）", "example": "clb.c2.medium" }, { "name": "ClusterTag", "type": "string", "required": false, "description": "Stgw独占集群的标签。", "example": "ziyan" }, { "name": "Zones", "type": "array", "required": false, "description": "仅适用于私有网络内网负载均衡。内网就近接入时，选择可用区下发。可调用[DescribeZones](https://cloud.tencent.com/document/product/213/15707)接口查询可用区列表。", "example": "[\"ap-guangzhou-3\"]", "item_type": "string" }, { "name": "EipAddressId", "type": "string", "required": false, "description": "EIP 的唯一 ID，形如：eip-qhx8udkc，仅适用于内网负载均衡绑定EIP，可以通过 [DescribeAddresses](https://cloud.tencent.com/document/product/215/16702) 接口查询。", "example": "eip-qhx8udkc" } ], "required": [ "LoadBalancerId" ] }, { "name": "CreateClsLogSet", "description": "创建CLB专有日志集，此日志集用于存储CLB的日志。", "status": "online", "parameters": [ { "name": "LogsetName", "type": "string", "required": false, "description": "日志集的名字，不能和cls其他日志集重名。不填默认为clb_logset。", "example": "clb_logset" }, { "name": "LogsetType", "type": "string", "required": false, "description": "日志集类型，ACCESS：访问日志，HEALTH：健康检查日志，默认ACCESS。", "example": "ACCESS" } ], "required": [] }, { "name": "CreateListener", "description": "在一个负载均衡实例下创建监听器。 本接口为异步接口，接口返回成功后，需以返回的 RequestId 为入参，调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例 ID，可以通过 DescribeLoadBalancers 接口获取。", "example": "lb-cuxw****" }, { "name": "Ports", "type": "array", "required": true, "description": "要将监听器创建到哪些端口，每个端口对应一个新的监听器。端口范围：1~65535", "example": "[7569, 7570]", "item_type": "integer" }, { "name": "Protocol", "type": "string", "required": true, "description": "监听器协议： TCP | UDP | HTTP | HTTPS | TCP_SSL | QUIC。", "example": "TCP" }, { "name": "ListenerNames", "type": "array", "required": false, "description": "要创建的监听器名称列表，名称与Ports数组按序一一对应，如不需立即命名，则无需提供此参数。命名规则：1-80 个英文字母、汉字等国际通用语言字符，数字，连接线“-”、下划线“_”等常见字符（禁止Unicode补充字符，如emoji表情、生僻汉字等）。", "example": "[\"listener0\",\"listener1\"]", "item_type": "string" }, { "name": "HealthCheck", "type": "object", "required": false, "description": "健康检查相关参数，此参数仅适用于TCP/UDP/TCP_SSL/QUIC监听器。", "example": "无", "children": [ { "name": "HealthSwitch", "type": "integer", "required": false, "description": "是否开启健康检查：1（开启）、0（关闭）。 默认为开启。", "example": "0" }, { "name": "TimeOut", "type": "integer", "required": false, "description": "健康检查的响应超时时间，可选值：2~60，默认值：2，单位：秒。响应超时时间要小于检查间隔时间。", "example": "2" }, { "name": "IntervalTime", "type": "integer", "required": false, "description": "健康检查探测间隔时间，默认值：5，IPv4 CLB实例的取值范围为：2-300，IPv6 CLB 实例的取值范围为：5-300。单位：秒。 说明：部分老旧 IPv4 CLB实例的取值范围为：5-300。", "example": "5" }, { "name": "HealthNum", "type": "integer", "required": false, "description": "健康阈值，默认值：3，表示当连续探测三次健康则表示该转发正常，可选值：2~10，单位：次。", "example": "3" }, { "name": "UnHealthNum", "type": "integer", "required": false, "description": "不健康阈值，默认值：3，表示当连续探测三次不健康则表示该转发异常，可选值：2~10，单位：次。", "example": "3" }, { "name": "HttpCode", "type": "integer", "required": false, "description": "健康检查状态码（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式）。可选值：1~31，默认 31。 1 表示探测后返回值 1xx 代表健康，2 表示返回 2xx 代表健康，4 表示返回 3xx 代表健康，8 表示返回 4xx 代表健康，16 表示返回 5xx 代表健康。若希望多种返回码都可代表健康，则将相应的值相加。 注意：此字段可能返回 null，表示取不到有效值。", "example": "8" }, { "name": "HttpCheckPath", "type": "string", "required": false, "description": "健康检查路径（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "/xxx" }, { "name": "HttpCheckDomain", "type": "string", "required": false, "description": "健康检查域名，将在HTTP协议 Host 头字段中携带。（仅适用于HTTP/HTTPS监听器和TCP监听器的HTTP健康检查方式。针对TCP监听器，当使用HTTP健康检查方式时，该参数为必填项）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "www.xxxx.com" }, { "name": "HttpCheckMethod", "type": "string", "required": false, "description": "健康检查方法（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式），默认值：HEAD，可选值HEAD或GET。 注意：此字段可能返回 null，表示取不到有效值。", "example": "HEAD" }, { "name": "CheckPort", "type": "integer", "required": false, "description": "自定义探测相关参数。健康检查端口，默认为后端服务的端口，除非您希望指定特定端口，否则建议留空。传参数值-1可恢复默认设置。（仅适用于TCP/UDP监听器）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "8000" }, { "name": "ContextType", "type": "string", "required": false, "description": "自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查的输入格式，可取值：HEX或TEXT；取值为HEX时，SendContext和RecvContext的字符只能在0123456789ABCDEF中选取且长度必须是偶数位。（仅适用于TCP/UDP监听器） 注意：此字段可能返回 null，表示取不到有效值。", "example": "TEXT" }, { "name": "SendContext", "type": "string", "required": false, "description": "自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查发送的请求内容，只允许ASCII可见字符，最大长度限制500。（仅适用于TCP/UDP监听器）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "request-info" }, { "name": "RecvContext", "type": "string", "required": false, "description": "自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查返回的结果，只允许ASCII可见字符，最大长度限制500。（仅适用于TCP/UDP监听器）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "response-info" }, { "name": "CheckType", "type": "string", "required": false, "description": "健康检查使用的协议。取值 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默认值与后端转发协议一致。", "example": "HTTP" }, { "name": "HttpVersion", "type": "string", "required": false, "description": "HTTP版本。健康检查协议CheckType的值取HTTP时，必传此字段，代表后端服务的HTTP版本：HTTP/1.0、HTTP/1.1；（仅适用于TCP监听器） 注意：此字段可能返回 null，表示取不到有效值。", "example": "HTTP/1.1" }, { "name": "SourceIpType", "type": "integer", "required": false, "description": "健康检查源IP类型：0（使用LB的VIP作为源IP），1（使用100.64网段IP作为源IP）。", "example": "0" }, { "name": "ExtendedCode", "type": "string", "required": false, "description": "GRPC健康检查状态码（仅适用于后端转发协议为GRPC的规则）。默认值为 12，可输入值为数值、多个数值、或者范围，例如 20 或 20,25 或 0-99 注意：此字段可能返回 null，表示取不到有效值。", "example": "12" } ] }, { "name": "Certificate", "type": "object", "required": false, "description": "证书相关信息。参数限制如下：此参数仅适用于TCP_SSL监听器和未开启SNI特性的HTTPS监听器。创建TCP_SSL监听器和未开启SNI特性的HTTPS监听器时，此参数和参数MultiCertInfo至少需要传一个， 但不能同时传入。", "example": "无", "children": [ { "name": "SSLMode", "type": "string", "required": false, "description": "认证类型，UNIDIRECTIONAL：单向认证，MUTUAL：双向认证。 默认为 UNIDIRECTIONAL。", "example": "UNIDIRECTIONAL" }, { "name": "SSLVerifyClient", "type": "string", "required": false, "description": "双向认证时，是否开启客户端认证，ON:开启，OPTIONAL:自适应，默认ON。", "example": "ON" }, { "name": "CertId", "type": "string", "required": false, "description": "服务端证书的 ID，如果不填写此项则必须上传证书，包括 CertContent（服务端证书内容），CertKey（服务端证书密钥），CertName（服务端证书名称）。", "example": "Fm8Wpag8" }, { "name": "CertCaId", "type": "string", "required": false, "description": "客户端证书的 ID，当监听器采用双向认证，即 SSLMode=MUTUAL 时，如果不填写此项则必须上传客户端证书，包括 CertCaContent，CertCaName。", "example": "HcsGe9BH" }, { "name": "CertName", "type": "string", "required": false, "description": "上传服务端证书的名称，如果没有 CertId，则此项必传。", "example": "NewCert" }, { "name": "CertKey", "type": "string", "required": false, "description": "上传服务端证书的 key，如果没有 CertId，则此项必传。", "example": "-----BEGIN RSA PRIVATE KEY----- certkey -----END RSA PRIVATE KEY-----" }, { "name": "CertContent", "type": "string", "required": false, "description": "上传服务端证书的内容，如果没有 CertId，则此项必传。", "example": "-----BEGIN CERTIFICATE----- certcontent -----END CERTIFICATE" }, { "name": "CertCaName", "type": "string", "required": false, "description": "上传客户端 CA 证书的名称，如果 SSLMode=MUTUAL，如果没有 CertCaId，则此项必传。", "example": "new_certca" }, { "name": "CertCaContent", "type": "string", "required": false, "description": "上传客户端证书的内容，如果 SSLMode=MUTUAL，如果没有 CertCaId，则此项必传。", "example": "-----BEGIN CERTIFICATE----- certcontent -----END CERTIFICATE" } ] }, { "name": "SessionExpireTime", "type": "integer", "required": false, "description": "会话保持时间，单位：秒。可选值：30~3600，默认为0，默认不开启。此参数仅适用于TCP/UDP监听器。", "example": "60" }, { "name": "Scheduler", "type": "string", "required": false, "description": "监听器转发的方式。可选值：WRR（按权重轮询）、LEAST_CONN（按最小连接数）默认为 WRR。此参数仅适用于TCP/UDP/TCP_SSL/QUIC监听器。", "example": "WRR" }, { "name": "SniSwitch", "type": "integer", "required": false, "description": "是否开启SNI特性，此参数仅适用于HTTPS监听器。0表示未开启，1表示开启。", "example": "1" }, { "name": "TargetType", "type": "string", "required": false, "description": "后端目标类型，NODE表示绑定普通节点，TARGETGROUP表示绑定目标组。此参数仅适用于TCP/UDP监听器。七层监听器应在转发规则中设置。", "example": "NODE" }, { "name": "SessionType", "type": "string", "required": false, "description": "会话保持类型。不传或传NORMAL表示默认会话保持类型。QUIC_CID 表示根据Quic Connection ID做会话保持。QUIC_CID只支持UDP协议。此参数仅适用于TCP/UDP监听器。七层监听器应在转发规则中设置。（若选择QUIC_CID，则Protocol必须为UDP，Scheduler必须为WRR，同时只支持ipv4）", "example": "NORMAL" }, { "name": "KeepaliveEnable", "type": "integer", "required": false, "description": "是否开启长连接，此参数仅适用于HTTP/HTTPS监听器，0:关闭；1:开启， 默认关闭。若后端服务对连接数上限有限制，则建议谨慎开启。此功能目前处于内测中，如需使用，请提交 内测申请。", "example": "0" }, { "name": "EndPort", "type": "integer", "required": false, "description": "创建端口段监听器时必须传入此参数，用以标识结束端口。同时，入参Ports只允许传入一个成员，用以标识开始端口。【如果您需要体验端口段功能，请通过 工单申请】。", "example": "1000" }, { "name": "DeregisterTargetRst", "type": "boolean", "required": false, "description": "重新调度功能，解绑后端服务开关，打开此开关，当解绑后端服务时触发重新调度。仅TCP/UDP监听器支持。", "example": "false" }, { "name": "MultiCertInfo", "type": "object", "required": false, "description": "证书信息，支持同时传入不同算法类型的多本服务端证书，参数限制如下：此参数仅适用于TCP_SSL监听器和未开启SNI特性的HTTPS监听器。创建TCP_SSL监听器和未开启SNI特性的HTTPS监听器时，此参数和参数Certificate至少需要传一个， 但不能同时传入。", "example": "无", "children": [ { "name": "SSLMode", "type": "string", "required": true, "description": "认证类型，UNIDIRECTIONAL：单向认证，MUTUAL：双向认证", "example": "UNIDIRECTIONAL" }, { "name": "CertList", "type": "array", "required": true, "description": "监听器或规则证书列表，单双向认证，多本服务端证书算法类型不能重复;若SSLMode为双向认证，证书列表必须包含一本ca证书。", "example": "见起类型示例", "item_type": "object", "children": [ { "name": "CertId", "type": "string", "required": false, "description": "证书 ID，如果不填写此项则必须上传证书内容，包括CertName, CertContent，若为服务端证书必须包含CertKey。", "example": "zFzZAAIr" }, { "name": "CertName", "type": "string", "required": false, "description": "上传证书的名称，如果没有 CertId，则此项必传。", "example": "tes-cert" }, { "name": "CertContent", "type": "string", "required": false, "description": "上传证书的公钥；如果没有 CertId，则此项必传。", "example": " -----BEGIN CERTIFICATE-----" }, { "name": "CertKey", "type": "string", "required": false, "description": "上传服务端证书的私钥；如果没有 CertId，则此项必传。", "example": "-----BEGIN RSA PRIVATE KEY----- " } ] }, { "name": "SSLVerifyClient", "type": "string", "required": false, "description": "双向认证时，是否开启客户端认证，ON:开启，OPTIONAL:自适应，默认ON", "example": "ON" } ] }, { "name": "MaxConn", "type": "integer", "required": false, "description": "监听器最大连接数，当前仅性能容量型实例且仅TCP/UDP/TCP_SSL/QUIC监听器支持，不传或者传-1表示监听器维度不限速。基础网络实例不支持该参数。", "example": "1000" }, { "name": "MaxCps", "type": "integer", "required": false, "description": "监听器最大新增连接数，当前仅性能容量型实例且仅TCP/UDP/TCP_SSL/QUIC监听器支持，不传或者传-1表示监听器维度不限速。基础网络实例不支持该参数。", "example": "1000" }, { "name": "IdleConnectTimeout", "type": "integer", "required": false, "description": "空闲连接超时时间，此参数仅适用于TCP/UDP监听器，单位：秒。默认值：TCP监听器默认值为900s，UDP监听器默认值为300s。取值范围：共享型实例和独占型实例支持：10-900，性能容量型实例支持：10-1980。如需设置超过取值范围的值请通过 工单申请。取值范围：[10, 1980]单位：秒默认值：900TCP监听器默认值为900s，UDP监听器默认值为300s。取值范围：共享型实例和独占型实例支持：10-900...", "example": "900" }, { "name": "ProxyProtocol", "type": "boolean", "required": false, "description": "TCP_SSL和QUIC是否支持PP", "example": "false" }, { "name": "SnatEnable", "type": "boolean", "required": false, "description": "是否开启SNAT（源IP替换），True（开启）、False（关闭）。默认为关闭。注意：SnatEnable开启时会替换客户端源IP，此时透传客户端源IP选项关闭，反之亦然。", "example": "false" }, { "name": "FullEndPorts", "type": "array", "required": false, "description": "全端口段监听器的结束端口，端口范围：2 - 65535", "example": "[600]", "item_type": "integer" }, { "name": "H2cSwitch", "type": "boolean", "required": false, "description": "内网http监听器开启h2c开关，True（开启）、False（关闭）。默认为关闭。", "example": "false" }, { "name": "SslCloseSwitch", "type": "boolean", "required": false, "description": "控制 TCP_SSL 类型的监听器是否移除 SSL 加密层。开启后，监听器将作为普通 TCP 协议运行。 可选值：True： 关闭 SSL 功能（协议降级为纯文本 TCP）。False（默认）： 保持 SSL 功能开启。", "example": "false" }, { "name": "DataCompressMode", "type": "string", "required": false, "description": "数据压缩模式。可选值：transparent（透传模式）、compatibility（兼容模式）", "example": "transparent/compatibility" }, { "name": "RescheduleTargetZeroWeight", "type": "boolean", "required": false, "description": "重新调度功能，权重调为0开关，打开此开关，后端服务器权重调为0时触发重新调度。仅TCP/UDP监听器支持。", "example": "false" }, { "name": "RescheduleUnhealthy", "type": "boolean", "required": false, "description": "重新调度功能，健康检查异常开关，打开此开关，后端服务器健康检查异常时触发重新调度。仅TCP/UDP监听器支持。", "example": "false" }, { "name": "RescheduleExpandTarget", "type": "boolean", "required": false, "description": "重新调度功能，扩容后端服务开关，打开此开关，后端服务器增加或者减少时触发重新调度。仅TCP/UDP监听器支持。", "example": "false" }, { "name": "RescheduleStartTime", "type": "integer", "required": false, "description": "重新调度触发开始时间，取值0~3600s。仅TCP/UDP监听器支持。", "example": "1" }, { "name": "RescheduleInterval", "type": "integer", "required": false, "description": "重新调度触发持续时间，取值0~3600s。仅TCP/UDP监听器支持。", "example": "1" } ], "required": [ "LoadBalancerId", "Ports", "Protocol" ] }, { "name": "CreateLoadBalancer", "description": "本接口(CreateLoadBalancer)用来创建负载均衡实例。为了使用负载均衡服务，您必须购买一个或多个负载均衡实例。成功调用该接口后，会返回负载均衡实例的唯一 ID。负载均衡实例的类型分为：公网、内网。详情可参考产品说明中的产品类型。 注意：(1)可通过 [DescribeResources](https://cloud.tencent.com/document/api/214/70213) 接口查询一个地域是否支持创建IPv6实例；(2)一个账号在每个地域的\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "LoadBalancerType", "type": "string", "required": true, "description": "负载均衡实例的网络类型：OPEN：公网属性， INTERNAL：内网属性。", "example": "OPEN" }, { "name": "Forward", "type": "integer", "required": false, "description": "负载均衡实例的类型。1：通用的负载均衡实例，目前只支持传入1。", "example": "1" }, { "name": "LoadBalancerName", "type": "string", "required": false, "description": "负载均衡实例的名称，只在创建一个实例的时候才会生效。规则：1-80 个英文字母、汉字等国际通用语言字符，数字，连接线“-”、下划线“_”等常见字符（禁止Unicode补充字符，如emoji表情、生僻汉字等）。注意：如果名称与系统中已有负载均衡实例的名称相同，则系统将会自动生成此次创建的负载均衡实例的名称。", "example": "test-cvm-bussiness" }, { "name": "VpcId", "type": "string", "required": false, "description": "负载均衡后端目标设备所属的网络 ID，如vpc-12345678，可以通过 DescribeVpcs 接口获取。 不填此参数则默认为DefaultVPC。创建内网负载均衡实例时，此参数必填。", "example": "vpc-30xq****" }, { "name": "SubnetId", "type": "string", "required": false, "description": "在私有网络内购买内网负载均衡实例的情况下，必须指定子网 ID，内网负载均衡实例的 VIP 将从这个子网中产生。创建内网负载均衡实例时，此参数必填，创建公网IPv4负载均衡实例时，不支持指定该参数。", "example": "subnet-dva8****" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "负载均衡实例所属的项目 ID，默认项目 ID 为0。可以通过 DescribeProject 接口获取。不填此参数则视为默认项目。", "example": "0" }, { "name": "AddressIPVersion", "type": "string", "required": false, "description": "仅适用于公网负载均衡。IP版本，可取值：IPV4、IPV6、IPv6FullChain，不区分大小写，默认值 IPV4。说明：取值为IPV6表示为IPV6 NAT64版本；取值为IPv6FullChain，表示为IPv6版本。", "example": "IPV4" }, { "name": "Number", "type": "integer", "required": false, "description": "创建负载均衡的个数，默认值 1。创建个数不能超过账号所能创建的最大值，默认创建最大值为20。", "example": "1" }, { "name": "MasterZoneId", "type": "string", "required": false, "description": "仅适用于公网且IP版本为IPv4的负载均衡。设置跨可用区容灾时的主可用区ID， 可用区 ID 和名称均支持，例如 100001 或 ap-guangzhou-1注：主可用区是需要承载流量的可用区，备可用区默认不承载流量，主可用区不可用时才使用备可用区。", "example": "ap-guangzhou-1" }, { "name": "ZoneId", "type": "string", "required": false, "description": "仅适用于公网且IP版本为IPv4的负载均衡。可用区ID，可用区 ID 和名称均支持，指定可用区以创建负载均衡实例。如：100001 或 ap-guangzhou-1。", "example": "ap-guangzhou-1" }, { "name": "InternetAccessible", "type": "object", "required": false, "description": "网络计费模式，最大出带宽。仅对内网属性的性能容量型实例和公网属性的所有实例生效。API接口购买包年包月实例还在灰度中，如您需要体验该功能，请通过 工单申请", "example": "无", "children": [ { "name": "InternetChargeType", "type": "string", "required": false, "description": "TRAFFIC_POSTPAID_BY_HOUR 按流量按小时后计费 ; BANDWIDTH_POSTPAID_BY_HOUR 按带宽按小时后计费，国际站用户不支持该计费模式; BANDWIDTH_PACKAGE 按带宽包计费;BANDWIDTH_PREPAID按带宽预付费。", "example": "BANDWIDTH_POSTPAID_BY_HOUR" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "最大出带宽，单位Mbps，仅对公网属性的共享型、性能容量型和独占型 CLB 实例、以及内网属性的性能容量型 CLB 实例生效。 - 对于公网属性的共享型和独占型 CLB 实例，最大出带宽的范围为1Mbps-2048Mbps。 - 对于公网属性和内网属性的性能容量型 CLB实例，最大出带宽的范围为1Mbps-61440Mbps。 （调用CreateLoadBalancer创建LB时不指定此参数则设置为默认值10Mbps。此上限可调整）", "example": "1" }, { "name": "BandwidthpkgSubType", "type": "string", "required": false, "description": "带宽包的类型，如 BGP（多线）。 类型如下： SINGLEISP: 单线 BGP: 多线 HIGH_QUALITY_BGP: 精品BGP共享带宽包 SINGLEISP_CMCC: 中国移动共享带宽包 SINGLEISP_CTCC: 中国电信共享带宽包 SINGLEISP_CUCC: 中国联通共享带宽包 注意：此字段可能返回 null，表示取不到有效值。", "example": "SINGLEISP" } ] }, { "name": "VipIsp", "type": "string", "required": false, "description": "仅适用于公网负载均衡。目前仅广州、上海、南京、济南、杭州、福州、北京、石家庄、武汉、长沙、成都、重庆地域支持静态单线 IP 线路类型，如需体验，请联系商务经理申请。申请通过后，即可选择中国移动（CMCC）、中国联通（CUCC）或中国电信（CTCC）的运营商类型，网络计费模式只能使用按带宽包计费(BANDWIDTH_PACKAGE)。 如果不指定本参数，则默认使用BGP。可通过 DescribeRe...", "example": "CMCC" }, { "name": "Tags", "type": "array", "required": false, "description": "购买负载均衡的同时，给负载均衡打上标签，最大支持20个标签键值对。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签的键", "example": "key-xxx" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签的值", "example": "value-xxx" } ] }, { "name": "Vip", "type": "string", "required": false, "description": "指定VIP申请负载均衡。此参数选填，不填写此参数时自动分配VIP。IPv4和IPv6类型支持此参数，IPv6 NAT64类型不支持。注意：当指定VIP创建内网实例、或公网IPv6 BGP实例时，若VIP不属于指定VPC子网的网段内时，会创建失败；若VIP已被占用，也会创建失败。", "example": "139.X.X.X" }, { "name": "BandwidthPackageId", "type": "string", "required": false, "description": "带宽包ID，可以通过 DescribeBandwidthPackages 接口获取。指定此参数时，网络计费方式（InternetAccessible.InternetChargeType）只支持按带宽包计费（BANDWIDTH_PACKAGE），带宽包的属性即为其结算方式。非上移用户购买的 IPv6 负载均衡实例，且运营商类型非 BGP 时 ，不支持指定具体带宽包id。", "example": "bwp-pnbe****" }, { "name": "ExclusiveCluster", "type": "object", "required": false, "description": "独占型实例信息。若创建独占型的内网负载均衡实例，则此参数必填。", "example": "无", "children": [ { "name": "L4Clusters", "type": "array", "required": false, "description": "4层独占集群列表 注意：此字段可能返回 null，表示取不到有效值。", "item_type": "object", "children": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群唯一ID", "example": "tgw-p1zxs4fu" }, { "name": "ClusterName", "type": "string", "required": false, "description": "集群名称", "example": "guangzhou-zone4-M6-S4-40G-CAP-CLB-TPNS-SET1" }, { "name": "Zone", "type": "string", "required": false, "description": "集群所在可用区，如ap-guangzhou-1 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-guangzhou-1" } ] }, { "name": "L7Clusters", "type": "array", "required": false, "description": "7层独占集群列表 注意：此字段可能返回 null，表示取不到有效值。", "item_type": "object", "children": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群唯一ID", "example": "tgw-p1zxs4fu" }, { "name": "ClusterName", "type": "string", "required": false, "description": "集群名称", "example": "guangzhou-zone4-M6-S4-40G-CAP-CLB-TPNS-SET1" }, { "name": "Zone", "type": "string", "required": false, "description": "集群所在可用区，如ap-guangzhou-1 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-guangzhou-1" } ] }, { "name": "ClassicalCluster", "type": "object", "required": false, "description": "vpcgw集群 注意：此字段可能返回 null，表示取不到有效值。", "children": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群唯一ID", "example": "tgw-p1zxs4fu" }, { "name": "ClusterName", "type": "string", "required": false, "description": "集群名称", "example": "guangzhou-zone4-M6-S4-40G-CAP-CLB-TPNS-SET1" }, { "name": "Zone", "type": "string", "required": false, "description": "集群所在可用区，如ap-guangzhou-1 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-guangzhou-1" } ] } ] }, { "name": "SlaType", "type": "string", "required": false, "description": "性能容量型规格。若需要创建性能容量型实例，则此参数必填，取值范围： 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规格 若需要创建共享型实例，则无需填写此参数。如需了解规格详情，请参见[实例规格对比](https://cloud.tencent.com/document/product/214/84689)。", "example": "clb.c2.medium" }, { "name": "ClusterIds", "type": "array", "required": false, "description": "集群ID，集群标识，在需要配置公有云独占集群或本地专有集群时使用。公有云独占集群申请请提交工单，本地专有集群请参考本地专有集群描述。", "example": "[\"cluster-gbo2****\"]", "item_type": "string" }, { "name": "ClientToken", "type": "string", "required": false, "description": "用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。", "example": "23494*****" }, { "name": "SnatPro", "type": "boolean", "required": false, "description": "是否支持绑定跨地域/跨Vpc绑定IP的功能。", "example": "true" }, { "name": "SnatIps", "type": "array", "required": false, "description": "开启绑定跨地域/跨Vpc绑定IP的功能后，创建SnatIp。", "example": "无", "item_type": "object", "children": [ { "name": "SubnetId", "type": "string", "required": true, "description": "私有网络子网的唯一性id，如subnet-12345678", "example": "subnet-3152159" }, { "name": "Ip", "type": "string", "required": false, "description": "IP地址，如192.168.0.1", "example": "192.168.0.1" } ] }, { "name": "ClusterTag", "type": "string", "required": false, "description": "Stgw独占集群的标签。", "example": "ziyan" }, { "name": "SlaveZoneId", "type": "string", "required": false, "description": "仅适用于公网且IP版本为IPv4的负载均衡。设置跨可用区容灾时的备可用区ID，可用区 ID 和名称均支持，例如 100001 或 ap-guangzhou-1注：备可用区是主可用区故障后，需要承载流量的可用区。可通过 DescribeResources 接口查询一个地域的主/备可用区的列表。【如果您需要体验该功能，请通过 工单申请】", "example": "ap-guangzhou-1" }, { "name": "EipAddressId", "type": "string", "required": false, "description": "EIP 的唯一 ID，可以通过 DescribeAddresses 接口查询。形如：eip-qhx8udkc，仅适用于内网负载均衡绑定EIP。", "example": "eip-qhx8udkc" }, { "name": "LoadBalancerPassToTarget", "type": "boolean", "required": false, "description": "Target是否放通来自CLB的流量。开启放通（true）：只验证CLB上的安全组；不开启放通（false）：需同时验证CLB和后端实例上的安全组。IPv6 CLB安全组默认放通，不需要传此参数。", "example": "true" }, { "name": "DynamicVip", "type": "boolean", "required": false, "description": "创建域名化负载均衡。", "example": "true" }, { "name": "Egress", "type": "string", "required": false, "description": "网络出口", "example": "center_egress1" }, { "name": "LBChargePrepaid", "type": "object", "required": false, "description": "负载均衡实例的预付费相关属性，API接口购买包年包月实例还在灰度中，如您需要体验该功能，请通过 工单申请", "example": "无", "children": [ { "name": "RenewFlag", "type": "string", "required": false, "description": "续费类型：AUTO_RENEW 自动续费， MANUAL_RENEW 手动续费", "example": "AUTO_RENEW" }, { "name": "Period", "type": "integer", "required": false, "description": "购买时长，单位：月", "example": "1" } ] }, { "name": "LBChargeType", "type": "string", "required": false, "description": "负载均衡实例计费类型，取值：POSTPAID_BY_HOUR，PREPAID，默认是POSTPAID_BY_HOUR。API接口购买包年包月实例还在灰度中，如您需要体验该功能，请通过 工单申请", "example": "POSTPAID_BY_HOUR" }, { "name": "AccessLogTopicId", "type": "string", "required": false, "description": "七层访问日志主题ID", "example": "9ec21ce7-a71b-4ba7-afb1-c1bd630233**" }, { "name": "AdvancedRoute", "type": "boolean", "required": false, "description": "是否开启七层高级路由", "example": "false" } ], "required": [ "LoadBalancerType" ] }, { "name": "CreateLoadBalancerSnatIps", "description": "针对SnatPro负载均衡，这个接口用于添加SnatIp，如果负载均衡没有开启SnatPro，添加SnatIp后会自动开启。 本接口为异步接口，接口返回成功后，需以得到的 RequestID 为入参，调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡唯一性ID，可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。例如：lb-12345678。", "example": "lb-cuxw****" }, { "name": "SnatIps", "type": "array", "required": true, "description": "添加的SnatIp信息，可指定IP申请，或者指定子网自动申请。可以通过 [DescribeSubnets](https://cloud.tencent.com/document/api/215/15784) 查询获取，单个CLB实例可申请的默认上限为10个。", "example": "无", "item_type": "object", "children": [ { "name": "SubnetId", "type": "string", "required": true, "description": "私有网络子网的唯一性id，如subnet-12345678", "example": "subnet-3152159" }, { "name": "Ip", "type": "string", "required": false, "description": "IP地址，如192.168.0.1", "example": "192.168.0.1" } ] }, { "name": "Number", "type": "integer", "required": false, "description": "添加的SnatIp的个数，可与SnatIps一起使用，但若指定IP时，则不能指定创建的SnatIp个数。默认值为1，数量上限与用户配置有关，默认上限为10。", "example": "2" } ], "required": [ "LoadBalancerId", "SnatIps" ] }, { "name": "CreateRule", "description": "CreateRule 接口用于在一个已存在的负载均衡七层监听器下创建转发规则，七层监听器中，后端服务必须绑定到规则上而非监听器上。 本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例 ID，可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取", "example": "lb-cuxw****" }, { "name": "ListenerId", "type": "string", "required": true, "description": "监听器 ID，可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口获取", "example": "lbl-4fbx*****" }, { "name": "Rules", "type": "array", "required": true, "description": "新建转发规则的信息。", "example": "无", "item_type": "object", "children": [ { "name": "Url", "type": "string", "required": true, "description": "转发规则的路径。长度限制为：1~200。", "example": "/xxxx" }, { "name": "Domain", "type": "string", "required": false, "description": "转发规则的域名。长度限制为：1~80。Domain和Domains只需要传一个，单域名规则传Domain，多域名规则传Domains。", "example": "www.xxxx.com" }, { "name": "SessionExpireTime", "type": "integer", "required": false, "description": "会话保持时间。设置为0表示关闭会话保持，开启会话保持可取值30~86400，单位：秒。", "example": "30" }, { "name": "HealthCheck", "type": "object", "required": false, "description": "健康检查信息。详情请参见：[健康检查](https://cloud.tencent.com/document/product/214/6097)", "example": "无", "children": [ { "name": "HealthSwitch", "type": "integer", "required": false, "description": "是否开启健康检查：1（开启）、0（关闭）。 默认为开启。", "example": "0" }, { "name": "TimeOut", "type": "integer", "required": false, "description": "健康检查的响应超时时间，可选值：2~60，默认值：2，单位：秒。响应超时时间要小于检查间隔时间。", "example": "2" }, { "name": "IntervalTime", "type": "integer", "required": false, "description": "健康检查探测间隔时间，默认值：5，IPv4 CLB实例的取值范围为：2-300，IPv6 CLB 实例的取值范围为：5-300。单位：秒。 说明：部分老旧 IPv4 CLB实例的取值范围为：5-300。", "example": "5" }, { "name": "HealthNum", "type": "integer", "required": false, "description": "健康阈值，默认值：3，表示当连续探测三次健康则表示该转发正常，可选值：2~10，单位：次。", "example": "3" }, { "name": "UnHealthNum", "type": "integer", "required": false, "description": "不健康阈值，默认值：3，表示当连续探测三次不健康则表示该转发异常，可选值：2~10，单位：次。", "example": "3" }, { "name": "HttpCode", "type": "integer", "required": false, "description": "健康检查状态码（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式）。可选值：1~31，默认 31。 1 表示探测后返回值 1xx 代表健康，2 表示返回 2xx 代表健康，4 表示返回 3xx 代表健康，8 表示返回 4xx 代表健康，16 表示返回 5xx 代表健康。若希望多种返回码都可代表健康，则将相应的值相加。 注意：此字段可能返回 null，表示取不到有效值。", "example": "8" }, { "name": "HttpCheckPath", "type": "string", "required": false, "description": "健康检查路径（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "/xxx" }, { "name": "HttpCheckDomain", "type": "string", "required": false, "description": "健康检查域名，将在HTTP协议 Host 头字段中携带。（仅适用于HTTP/HTTPS监听器和TCP监听器的HTTP健康检查方式。针对TCP监听器，当使用HTTP健康检查方式时，该参数为必填项）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "www.xxxx.com" }, { "name": "HttpCheckMethod", "type": "string", "required": false, "description": "健康检查方法（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式），默认值：HEAD，可选值HEAD或GET。 注意：此字段可能返回 null，表示取不到有效值。", "example": "HEAD" }, { "name": "CheckPort", "type": "integer", "required": false, "description": "自定义探测相关参数。健康检查端口，默认为后端服务的端口，除非您希望指定特定端口，否则建议留空。传参数值-1可恢复默认设置。（仅适用于TCP/UDP监听器）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "8000" }, { "name": "ContextType", "type": "string", "required": false, "description": "自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查的输入格式，可取值：HEX或TEXT；取值为HEX时，SendContext和RecvContext的字符只能在0123456789ABCDEF中选取且长度必须是偶数位。（仅适用于TCP/UDP监听器） 注意：此字段可能返回 null，表示取不到有效值。", "example": "TEXT" }, { "name": "SendContext", "type": "string", "required": false, "description": "自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查发送的请求内容，只允许ASCII可见字符，最大长度限制500。（仅适用于TCP/UDP监听器）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "request-info" }, { "name": "RecvContext", "type": "string", "required": false, "description": "自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查返回的结果，只允许ASCII可见字符，最大长度限制500。（仅适用于TCP/UDP监听器）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "response-info" }, { "name": "CheckType", "type": "string", "required": false, "description": "健康检查使用的协议。取值 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默认值与后端转发协议一致。", "example": "HTTP" }, { "name": "HttpVersion", "type": "string", "required": false, "description": "HTTP版本。健康检查协议CheckType的值取HTTP时，必传此字段，代表后端服务的HTTP版本：HTTP/1.0、HTTP/1.1；（仅适用于TCP监听器） 注意：此字段可能返回 null，表示取不到有效值。", "example": "HTTP/1.1" }, { "name": "SourceIpType", "type": "integer", "required": false, "description": "健康检查源IP类型：0（使用LB的VIP作为源IP），1（使用100.64网段IP作为源IP）。", "example": "0" }, { "name": "ExtendedCode", "type": "string", "required": false, "description": "GRPC健康检查状态码（仅适用于后端转发协议为GRPC的规则）。默认值为 12，可输入值为数值、多个数值、或者范围，例如 20 或 20,25 或 0-99 注意：此字段可能返回 null，表示取不到有效值。", "example": "12" } ] }, { "name": "Certificate", "type": "object", "required": false, "description": "证书信息；此参数和MultiCertInfo不能同时传入。", "example": "无", "children": [ { "name": "SSLMode", "type": "string", "required": false, "description": "认证类型，UNIDIRECTIONAL：单向认证，MUTUAL：双向认证。 默认为 UNIDIRECTIONAL。", "example": "UNIDIRECTIONAL" }, { "name": "SSLVerifyClient", "type": "string", "required": false, "description": "双向认证时，是否开启客户端认证，ON:开启，OPTIONAL:自适应，默认ON。", "example": "ON" }, { "name": "CertId", "type": "string", "required": false, "description": "服务端证书的 ID，如果不填写此项则必须上传证书，包括 CertContent（服务端证书内容），CertKey（服务端证书密钥），CertName（服务端证书名称）。", "example": "Fm8Wpag8" }, { "name": "CertCaId", "type": "string", "required": false, "description": "客户端证书的 ID，当监听器采用双向认证，即 SSLMode=MUTUAL 时，如果不填写此项则必须上传客户端证书，包括 CertCaContent，CertCaName。", "example": "HcsGe9BH" }, { "name": "CertName", "type": "string", "required": false, "description": "上传服务端证书的名称，如果没有 CertId，则此项必传。", "example": "NewCert" }, { "name": "CertKey", "type": "string", "required": false, "description": "上传服务端证书的 key，如果没有 CertId，则此项必传。", "example": "-----BEGIN RSA PRIVATE KEY----- certkey -----END RSA PRIVATE KEY-----" }, { "name": "CertContent", "type": "string", "required": false, "description": "上传服务端证书的内容，如果没有 CertId，则此项必传。", "example": "-----BEGIN CERTIFICATE----- certcontent -----END CERTIFICATE" }, { "name": "CertCaName", "type": "string", "required": false, "description": "上传客户端 CA 证书的名称，如果 SSLMode=MUTUAL，如果没有 CertCaId，则此项必传。", "example": "new_certca" }, { "name": "CertCaContent", "type": "string", "required": false, "description": "上传客户端证书的内容，如果 SSLMode=MUTUAL，如果没有 CertCaId，则此项必传。", "example": "-----BEGIN CERTIFICATE----- certcontent -----END CERTIFICATE" } ] }, { "name": "Scheduler", "type": "string", "required": false, "description": "规则的请求转发方式，可选值：WRR、LEAST_CONN、IP_HASH 分别表示按权重轮询、最小连接数、按IP哈希， 默认为 WRR。", "example": "WRR" }, { "name": "ForwardType", "type": "string", "required": false, "description": "负载均衡与后端服务之间的转发协议，目前支持 HTTP/HTTPS/GRPC/GRPCS/TRPC，TRPC暂未对外开放，默认HTTP。", "example": "HTTP" }, { "name": "DefaultServer", "type": "boolean", "required": false, "description": "是否将该域名设为默认域名，注意，一个监听器下只能设置一个默认域名。", "example": "true" }, { "name": "Http2", "type": "boolean", "required": false, "description": "是否开启Http2，注意，只有HTTPS域名才能开启Http2。", "example": "true" }, { "name": "TargetType", "type": "string", "required": false, "description": "后端目标类型，NODE表示绑定普通节点，TARGETGROUP表示绑定目标组", "example": "NODE" }, { "name": "TrpcCallee", "type": "string", "required": false, "description": "TRPC被调服务器路由，ForwardType为TRPC时必填。目前暂未对外开放。", "example": "trpcall" }, { "name": "TrpcFunc", "type": "string", "required": false, "description": "TRPC调用服务接口，ForwardType为TRPC时必填。目前暂未对外开放", "example": "trpcFunc" }, { "name": "Quic", "type": "boolean", "required": false, "description": "是否开启QUIC，注意，只有HTTPS域名才能开启QUIC", "example": "true" }, { "name": "Domains", "type": "array", "required": false, "description": "转发规则的域名列表。每个域名的长度限制为：1~80。Domain和Domains只需要传一个，单域名规则传Domain，多域名规则传Domains。", "example": "[\"www.xxxx.com\"]", "item_type": "string" }, { "name": "MultiCertInfo", "type": "object", "required": false, "description": "证书信息，支持同时传入不同算法类型的多本服务端证书；此参数和Certificate不能同时传入。", "example": "无", "children": [ { "name": "SSLMode", "type": "string", "required": true, "description": "认证类型，UNIDIRECTIONAL：单向认证，MUTUAL：双向认证", "example": "UNIDIRECTIONAL" }, { "name": "CertList", "type": "array", "required": true, "description": "监听器或规则证书列表，单双向认证，多本服务端证书算法类型不能重复;若SSLMode为双向认证，证书列表必须包含一本ca证书。", "example": "见起类型示例", "item_type": "object", "children": [ { "name": "CertId", "type": "string", "required": false, "description": "证书 ID，如果不填写此项则必须上传证书内容，包括CertName, CertContent，若为服务端证书必须包含CertKey。", "example": "zFzZAAIr" }, { "name": "CertName", "type": "string", "required": false, "description": "上传证书的名称，如果没有 CertId，则此项必传。", "example": "tes-cert" }, { "name": "CertContent", "type": "string", "required": false, "description": "上传证书的公钥；如果没有 CertId，则此项必传。", "example": " -----BEGIN CERTIFICATE-----" }, { "name": "CertKey", "type": "string", "required": false, "description": "上传服务端证书的私钥；如果没有 CertId，则此项必传。", "example": "-----BEGIN RSA PRIVATE KEY----- " } ] }, { "name": "SSLVerifyClient", "type": "string", "required": false, "description": "双向认证时，是否开启客户端认证，ON:开启，OPTIONAL:自适应，默认ON", "example": "ON" } ] }, { "name": "CookieName", "type": "string", "required": false, "description": "自定义cookie名", "example": "test_cookie" } ] } ], "required": [ "LoadBalancerId", "ListenerId", "Rules" ] }, { "name": "CreateTargetGroup", "description": "创建目标组。该功能正在内测中，如需使用，请通过[工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=6\u0026level2_id=163\u0026source=0\u0026data_title=%E8%B4%9F%E8%BD%BD%E5%9D%87%E8%A1%A1%20LB\u0026step=1)。", "status": "online", "parameters": [ { "name": "TargetGroupName", "type": "string", "required": false, "description": "目标组名称。命名规则：1-80 个英文字母、汉字等国际通用语言字符，数字，连接线“-”、下划线“_”等常见字符（禁止Unicode补充字符，如emoji表情、生僻汉字等）。", "example": "test-name" }, { "name": "VpcId", "type": "string", "required": false, "description": "目标组的vpcId属性，不填则使用默认vpc。", "example": "vpc-i1******" }, { "name": "Port", "type": "integer", "required": false, "description": "目标组的默认端口， 后续添加服务器时可使用该默认端口。全监听目标组不支持此参数，非全监听目标组Port和TargetGroupInstances.N中的port二者必填其一。", "example": "80" }, { "name": "TargetGroupInstances", "type": "array", "required": false, "description": "目标组绑定的后端服务器，单次最多支持50个。", "example": "无", "item_type": "object", "children": [ { "name": "BindIP", "type": "string", "required": true, "description": "目标组实例的内网IP", "example": "x.x.x.x" }, { "name": "Port", "type": "integer", "required": false, "description": "目标组实例的端口，全监听目标组不支持传此字段。", "example": "80" }, { "name": "Weight", "type": "integer", "required": false, "description": "目标组实例的权重 v2目标组需要配置权重，调用CreateTargetGroup接口创建目标组时该参数与创建接口中的Weight参数必填其一。 取值范围：0-100", "example": "10" }, { "name": "NewPort", "type": "integer", "required": false, "description": "目标组实例的新端口，全监听目标组不支持传此字段。", "example": "80" } ] }, { "name": "Type", "type": "string", "required": false, "description": "目标组类型，当前支持v1(旧版目标组), v2(新版目标组), 默认为v1(旧版目标组)。", "example": "v1" }, { "name": "Protocol", "type": "string", "required": false, "description": "目标组后端转发协议。v2新版目标组该项必填。目前支持TCP、UDP、HTTP、HTTPS、GRPC。", "example": "TCP" }, { "name": "HealthCheck", "type": "object", "required": false, "description": "健康检查。", "example": "无", "children": [ { "name": "HealthSwitch", "type": "boolean", "required": true, "description": "是否开启健康检查。", "example": "true" }, { "name": "Protocol", "type": "string", "required": false, "description": "健康检查方式， 其中仅V2新版目标组类型支持该参数， 支持取值 TCP | HTTP | HTTPS | PING | CUSTOM，其中: 当目标组后端转发协议为TCP时， 健康检查方式支持 TCP/HTTP/CUSTOM， 默认为TCP。当目标组后端转发协议为UDP时， 健康检查方式支持 PING/CUSTOM，默认为PING。当目标组后端转发协议为HTTP时， 健康检查方式支持 HTTP/TCP， 默认为HTTP。当目标组后端转发协议为HTTPS时， 健康检查方式支持 HT...", "example": "TCP" }, { "name": "Port", "type": "integer", "required": false, "description": "自定义探测相关参数。健康检查端口，默认为后端服务的端口，除非您希望指定特定端口，否则建议留空。（仅适用于TCP/UDP目标组）。", "example": "80" }, { "name": "Timeout", "type": "integer", "required": false, "description": "健康检查超时时间。 默认为2秒。 可配置范围：2 - 30秒。", "example": "2" }, { "name": "GapTime", "type": "integer", "required": false, "description": "检测间隔时间。 默认为5秒。 可配置范围：2 - 300秒。", "example": "5" }, { "name": "GoodLimit", "type": "integer", "required": false, "description": "检测健康阈值。 默认为3秒。 可配置范围：2 - 10次。", "example": "3" }, { "name": "BadLimit", "type": "integer", "required": false, "description": "检测不健康阈值。 默认为3秒。 可配置范围：2 - 10次。", "example": "3" }, { "name": "JumboFrame", "type": "boolean", "required": false, "description": "目标组下的所有rs的探测包是否开启巨帧。默认开启。仅GWLB类型目标组支持该参数。", "example": "true" }, { "name": "HttpCode", "type": "integer", "required": false, "description": "健康检查状态码（仅适用于HTTP/HTTPS目标组、TCP目标组的HTTP健康检查方式）。可选值：1~31，默认 31，其中： 1 表示探测后返回值 1xx 代表健康。2 表示返回 2xx 代表健康。4 表示返回 3xx 代表健康。8 表示返回 4xx 代表健康。16 表示返回 5xx 代表健康。若希望多种返回码都可代表健康，则将相应的值相加。 注意：此字段可能返回 null，表示取不到有效值。", "example": "504" }, { "name": "HttpCheckDomain", "type": "string", "required": false, "description": "健康检查域名， 其中：仅适用于HTTP/HTTPS目标组和TCP目标组的HTTP健康检查方式。针对HTTP/HTTPS目标组，当使用HTTP健康检查方式时，该参数为必填项。 注意：此字段可能返回 null，表示取不到有效值。", "example": "www.xxxx.com" }, { "name": "HttpCheckPath", "type": "string", "required": false, "description": "健康检查路径（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "/xxx\t/xxx" }, { "name": "HttpCheckMethod", "type": "string", "required": false, "description": "健康检查方法（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式），默认值：HEAD，可选值HEAD或GET。 注意：此字段可能返回 null，表示取不到有效值。", "example": "HEAD" }, { "name": "ContextType", "type": "string", "required": false, "description": "健康检查的输入格式，健康检查方式取CUSTOM时，必填此字段，可取值：HEX或TEXT，其中：TEXT：文本格式。HEX：十六进制格式， SendContext和RecvContext的字符只能在0123456789ABCDEF中选取且长度必须是偶数位。仅适用于TCP/UDP目标组。 注意：此字段可能返回 null，表示取不到有效值。", "example": "TEXT" }, { "name": "SendContext", "type": "string", "required": false, "description": "自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查发送的请求内容，只允许ASCII可见字符，最大长度限制500。（仅适用于TCP/UDP目标组）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ping" }, { "name": "RecvContext", "type": "string", "required": false, "description": "自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查返回的结果，只允许ASCII可见字符，最大长度限制500。（仅适用于TCP/UDP目标组）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "pong" }, { "name": "HttpVersion", "type": "string", "required": false, "description": "HTTP版本, 其中：健康检查协议CheckType的值取HTTP时，必传此字段。支持配置选项：HTTP/1.0, HTTP/1.1。仅适用于TCP目标组。 注意：此字段可能返回 null，表示取不到有效值。", "example": "HTTP/1.1" }, { "name": "ExtendedCode", "type": "string", "required": false, "description": "GRPC健康检查状态码（仅适用于后端转发协议为GRPC的目标组）。默认值为 12，可输入值为数值、多个数值、或者范围，例如 20 或 20,25 或 0-99。 注意：此字段可能返回 null，表示取不到有效值。", "example": "12" } ] }, { "name": "ScheduleAlgorithm", "type": "string", "required": false, "description": "调度算法，仅V2新版目标组，且后端转发协议为(HTTP|HTTPS|GRPC)时该参数有效。可选值：\u0026lt;ur\u0026gt;WRR:按权重轮询。LEAST_CONN:最小连接数。IP_HASH:按IP哈希。默认为 WRR。\u0026lt;ur\u0026gt;", "example": "WRR" }, { "name": "Tags", "type": "array", "required": false, "description": "标签。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签的键", "example": "key-xxx" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签的值", "example": "value-xxx" } ] }, { "name": "Weight", "type": "integer", "required": false, "description": "后端服务默认权重, 其中：取值范围[0, 100]设置该值后，添加后端服务到目标组时， 若后端服务不单独设置权重， 则使用这里的默认权重。 v1 目标组类型不支持设置 Weight 参数。", "example": "100" }, { "name": "FullListenSwitch", "type": "boolean", "required": false, "description": "全监听目标组标识，true表示是全监听目标组，false表示不是全监听目标组。仅V2新版类型目标组支持该参数。", "example": "true" }, { "name": "KeepaliveEnable", "type": "boolean", "required": false, "description": "是否开启长连接，此参数仅适用于HTTP/HTTPS目标组，0:关闭；1:开启， 默认关闭。", "example": "true" }, { "name": "SessionExpireTime", "type": "integer", "required": false, "description": "会话保持时间，单位：秒。可选值：30~3600，默认 0，表示不开启。仅V2新版且后端转发协议为HTTP/HTTPS/GRPC目标组支持该参数。", "example": "30" }, { "name": "IpVersion", "type": "string", "required": false, "description": "IP版本类型。", "example": "IPv4" }, { "name": "SnatEnable", "type": "boolean", "required": false, "description": "是否开启SNAT（源IP替换），True（开启）、False（关闭）。默认为关闭。注意：SnatEnable开启时会替换客户端源IP，此时透传客户端源IP选项关闭，反之亦然。", "example": "true" } ], "required": [] }, { "name": "CreateTopic", "description": "创建主题，默认开启全文索引和键值索引。如果不存在CLB专有日志集，则创建失败。", "status": "online", "parameters": [ { "name": "TopicName", "type": "string", "required": true, "description": "日志主题的名称。", "example": "clb-topic" }, { "name": "PartitionCount", "type": "integer", "required": false, "description": "主题分区Partition的数量，不传参默认创建1个，最大创建允许10个，分裂/合并操作会改变分区数量，整体上限50个。", "example": "3" }, { "name": "TopicType", "type": "string", "required": false, "description": "日志类型，ACCESS：访问日志，HEALTH：健康检查日志，默认ACCESS。", "example": "ACCESS" }, { "name": "Period", "type": "integer", "required": false, "description": "存储时间，单位天，默认为 30。 - 日志接入标准存储时，支持1至3600天，值为3640时代表永久保存。 - 日志接入低频存储时，支持7至3600天，值为3640时代表永久保存。", "example": "30" }, { "name": "StorageType", "type": "string", "required": false, "description": "日志主题的存储类型，可选值 HOT（标准存储），COLD（低频存储）；默认为HOT。", "example": "HOT" } ], "required": [ "TopicName" ] }, { "name": "DeleteListener", "description": "本接口用来删除负载均衡实例下的监听器（四层和七层）。 本接口为异步接口，接口返回成功后，需以得到的 RequestID 为入参，调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例ID，可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。", "example": "lb-cuxw****" }, { "name": "ListenerId", "type": "string", "required": true, "description": "要删除的监听器ID，可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。", "example": "lbl-4udz****" } ], "required": [ "LoadBalancerId", "ListenerId" ] }, { "name": "DeleteLoadBalancer", "description": "DeleteLoadBalancer 接口用以删除指定的一个或多个负载均衡实例。成功删除后，会把负载均衡实例下的监听器、转发规则一起删除，并把后端服务解绑。 本接口为异步接口，接口返回成功后，需以返回的 RequestId 为入参，调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。", "status": "online", "parameters": [ { "name": "LoadBalancerIds", "type": "array", "required": true, "description": "要删除的负载均衡实例 ID 数组，可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取，数组大小最大支持20。", "example": "[\"lb-hsb93u5o\"]", "item_type": "string" }, { "name": "ForceDelete", "type": "boolean", "required": false, "description": "是否强制删除clb。true表示强制删除，false表示不是强制删除，需要做拦截校验。 默认为false。 以下几种情况会默认拦截删除操作，如果触发情况1、2但确认强制删除则需要传强制校验参数ForceDelete为true。 1、删除后端绑定大于等于 20 个 RS 的实例时。 2、删除后端有 RS 且 5 分钟 内“出/入带宽”峰值取大 \u003e 10Mbps 的实例时。 3、单地域内 5 分钟 内删除大于等于 30 个实例时。", "example": "true" } ], "required": [ "LoadBalancerIds" ] }, { "name": "DeleteLoadBalancerListeners", "description": "该接口支持删除负载均衡的多个监听器。 本接口为异步接口，本接口返回成功后需以返回的 RequestID 为入参，调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例ID，可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。", "example": "lb-db2n****" }, { "name": "ListenerIds", "type": "array", "required": false, "description": "指定删除的监听器ID数组，最大为20个。若不填则删除负载均衡的所有监听器，可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。", "example": "[\"lbl-4fo6k8na\"]", "item_type": "string" } ], "required": [ "LoadBalancerId" ] }, { "name": "DeleteLoadBalancerSnatIps", "description": "这个接口用于删除SnatPro的负载均衡的SnatIp。 本接口为异步接口，接口返回成功后，需以得到的 RequestID 为入参，调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡唯一ID，可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459) 接口查询。例如：lb-12345678。", "example": "lb-cuxw****" }, { "name": "Ips", "type": "array", "required": true, "description": "删除SnatIp地址数组，最大支持删除数量为20个。", "example": "[\"192.168.0.128\"]", "item_type": "string" } ], "required": [ "LoadBalancerId", "Ips" ] }, { "name": "DeleteRewrite", "description": "DeleteRewrite 接口支持删除指定转发规则之间的重定向关系。 本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例ID。", "example": "lb-51jj****" }, { "name": "SourceListenerId", "type": "string", "required": true, "description": "源监听器ID。", "example": "lbl-r4ia****" }, { "name": "TargetListenerId", "type": "string", "required": true, "description": "目标监听器ID。", "example": "lbl-0non****" }, { "name": "RewriteInfos", "type": "array", "required": true, "description": "转发规则之间的重定向关系。", "example": "无", "item_type": "object", "children": [ { "name": "SourceLocationId", "type": "string", "required": true, "description": "源转发规则ID", "example": "loc-i82k****" }, { "name": "TargetLocationId", "type": "string", "required": true, "description": "重定向目标转发规则的ID", "example": "loc-lavx****" }, { "name": "RewriteCode", "type": "integer", "required": false, "description": "重定向状态码，可取值301,302,307", "example": "302" }, { "name": "TakeUrl", "type": "boolean", "required": false, "description": "重定向是否携带匹配的url，配置RewriteCode时必填", "example": "true" }, { "name": "SourceDomain", "type": "string", "required": false, "description": "源转发的域名，必须是SourceLocationId对应的域名，配置RewriteCode时必填", "example": "xxx.com" } ] } ], "required": [ "LoadBalancerId", "SourceListenerId", "TargetListenerId", "RewriteInfos" ] }, { "name": "DeleteRule", "description": "DeleteRule 接口用来删除负载均衡实例七层监听器下的转发规则。 本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例ID，可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。", "example": "lb-cuxw2rm0" }, { "name": "ListenerId", "type": "string", "required": true, "description": "负载均衡监听器ID，可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。", "example": "lbl-4fbxq45k" }, { "name": "LocationIds", "type": "array", "required": false, "description": "要删除的转发规则的ID组成的数组，可以通过 [DescribeLoadBalancersDetail](https://cloud.tencent.com/document/api/214/46916) 接口查询。", "example": "[\"loc-5lc6****\"]", "item_type": "string" }, { "name": "Domain", "type": "string", "required": false, "description": "要删除的转发规则的域名，如果是多域名，可以指定多域名列表中的任意一个，可以通过 [DescribeLoadBalancersDetail](https://cloud.tencent.com/document/api/214/46916) 接口查询。", "example": "foo.net" }, { "name": "Url", "type": "string", "required": false, "description": "要删除的转发规则的转发路径，可以通过 [DescribeLoadBalancersDetail](https://cloud.tencent.com/document/api/214/46916) 接口查询。", "example": "/bar2" }, { "name": "NewDefaultServerDomain", "type": "string", "required": false, "description": "监听器下必须配置一个默认域名，当需要删除默认域名时，可以指定另一个域名作为新的默认域名，如果新的默认域名是多域名，可以指定多域名列表中的任意一个，可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。", "example": "www.default.example.com" } ], "required": [ "LoadBalancerId", "ListenerId" ] }, { "name": "DeleteTargetGroups", "description": "删除目标组，支持批量删除目标组，单次最多批量删除 20 个目标组。", "status": "online", "parameters": [ { "name": "TargetGroupIds", "type": "array", "required": true, "description": "目标组的ID数组，单次最多支持删除20个。", "example": "[\"lbtg-f1phe5j6\"]", "item_type": "string" } ], "required": [ "TargetGroupIds" ] }, { "name": "DeregisterFunctionTargets", "description": "DeregisterFunctionTargets 接口用来将一个云函数从负载均衡的转发规则上解绑，对于七层监听器，还需通过 LocationId 或 Domain+Url 指定转发规则。 本接口为异步接口，本接口返回成功后需以返回的 RequestID 为入参，调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。 限制说明： - 仅广州、深圳金融、上海、上海金融、北京、成都、中国香港、新\ufffd...", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例 ID。", "example": "lb-1234abcd" }, { "name": "ListenerId", "type": "string", "required": true, "description": "负载均衡监听器 ID。", "example": "lbl-1234tgbh" }, { "name": "FunctionTargets", "type": "array", "required": true, "description": "待解绑的云函数列表。", "example": "无", "item_type": "object", "children": [ { "name": "Function", "type": "object", "required": true, "description": "云函数相关信息", "example": "无", "children": [ { "name": "FunctionNamespace", "type": "string", "required": true, "description": "函数命名空间", "example": "default" }, { "name": "FunctionName", "type": "string", "required": true, "description": "函数名称", "example": "bxs-open-api" }, { "name": "FunctionQualifier", "type": "string", "required": true, "description": "函数的版本名称或别名", "example": "$LATEST" }, { "name": "FunctionQualifierType", "type": "string", "required": false, "description": "标识 FunctionQualifier 参数的类型，可取值： VERSION（版本）、ALIAS（别名） 注意：此字段可能返回 null，表示取不到有效值。", "example": "VERSION" } ] }, { "name": "Weight", "type": "integer", "required": false, "description": "权重", "example": "10" } ] }, { "name": "LocationId", "type": "string", "required": false, "description": "目标转发规则的 ID，当将云函数从七层转发规则上解绑时，必须输入此参数或 Domain+Url 参数。", "example": "loc-1234rrrr" }, { "name": "Domain", "type": "string", "required": false, "description": "目标转发规则的域名，若已经输入 LocationId 参数，则本参数不生效。", "example": "www.123.com" }, { "name": "Url", "type": "string", "required": false, "description": "目标转发规则的 URL，若已经输入 LocationId 参数，则本参数不生效。", "example": "/test" } ], "required": [ "LoadBalancerId", "ListenerId", "FunctionTargets" ] }, { "name": "DeregisterTargetGroupInstances", "description": "从目标组中解绑服务器。 本接口为异步接口，本接口返回成功后需以返回的 RequestID 为入参，调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。", "status": "online", "parameters": [ { "name": "TargetGroupId", "type": "string", "required": true, "description": "目标组ID。", "example": "lbtg-815iz538" }, { "name": "TargetGroupInstances", "type": "array", "required": true, "description": "待解绑的服务器信息，支持批量解除绑定，单次批量解除数量最多为20个。 在这个接口 Port 参数为必填项。", "example": "无", "item_type": "object", "children": [ { "name": "BindIP", "type": "string", "required": true, "description": "目标组实例的内网IP", "example": "x.x.x.x" }, { "name": "Port", "type": "integer", "required": false, "description": "目标组实例的端口，全监听目标组不支持传此字段。", "example": "80" }, { "name": "Weight", "type": "integer", "required": false, "description": "目标组实例的权重 v2目标组需要配置权重，调用CreateTargetGroup接口创建目标组时该参数与创建接口中的Weight参数必填其一。 取值范围：0-100", "example": "10" }, { "name": "NewPort", "type": "integer", "required": false, "description": "目标组实例的新端口，全监听目标组不支持传此字段。", "example": "80" } ] } ], "required": [ "TargetGroupId", "TargetGroupInstances" ] }, { "name": "DeregisterTargets", "description": "DeregisterTargets 接口用来将一台或多台后端服务从负载均衡的监听器或转发规则上解绑，对于四层监听器，只需指定监听器ID即可，对于七层监听器，还需通过LocationId或Domain+Url指定转发规则。 本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例 ID，格式如 lb-12345678。", "example": "lb-cuxw****" }, { "name": "ListenerId", "type": "string", "required": true, "description": "监听器 ID，格式如 lbl-12345678。", "example": "lbl-d1ub****" }, { "name": "Targets", "type": "array", "required": true, "description": "要解绑的后端服务列表，数组长度最大支持20。", "example": "无", "item_type": "object", "children": [ { "name": "Port", "type": "integer", "required": true, "description": "后端服务的监听端口。 注意：绑定CVM（云服务器）或ENI（弹性网卡）时必传此参数", "example": "80" }, { "name": "Type", "type": "string", "required": false, "description": "后端服务的类型，可取：CVM（云服务器）、ENI（弹性网卡）；作为入参时，目前本参数暂不生效。", "example": "CVM" }, { "name": "InstanceId", "type": "string", "required": false, "description": "绑定CVM时需要传入此参数，代表CVM的唯一 ID，可通过 DescribeInstances 接口返回字段中的 InstanceId 字段获取。表示绑定主网卡主IPv4地址；以下场景都不支持指定InstanceId：绑定非CVM，绑定CVM上的辅助网卡IP，通过跨域2.0绑定CVM，以及绑定CVM的IPv6地址等。 注意：参数 InstanceId、EniIp 有且只能传入其中一个参数。", "example": "ins-xxxxxxxx" }, { "name": "Weight", "type": "integer", "required": false, "description": "后端服务修改后的转发权重，取值范围：[0, 100]，默认为 10。此参数的优先级高于[RsWeightRule](https://cloud.tencent.com/document/api/214/30694#RsWeightRule)中的Weight参数，即最终的权重值以此Weight参数值为准，仅当此Weight参数为空时，才以RsWeightRule中的Weight参数为准。", "example": "10" }, { "name": "EniIp", "type": "string", "required": false, "description": "绑定IP时需要传入此参数，支持弹性网卡的IP和其他内网IP，如果是弹性网卡则必须先绑定至CVM，然后才能绑定到负载均衡实例。 注意：参数 InstanceId、EniIp 有且只能传入其中一个参数。如果绑定双栈IPV6子机，则必须传该参数。如果是跨地域绑定，则必须传该参数，不支持传InstanceId参数。", "example": "x.x.x.x" }, { "name": "Tag", "type": "string", "required": false, "description": "标签。", "example": "tag_taget" } ] }, { "name": "LocationId", "type": "string", "required": false, "description": "转发规则的ID，格式如 loc-12345678，当从七层转发规则解绑机器时，必须提供此参数或Domain+URL两者之一。", "example": "loc-1234****" }, { "name": "Domain", "type": "string", "required": false, "description": "目标规则的域名，提供LocationId参数时本参数不生效。", "example": "www.aaa.com" }, { "name": "Url", "type": "string", "required": false, "description": "目标规则的URL，提供LocationId参数时本参数不生效。", "example": "/test" } ], "required": [ "LoadBalancerId", "ListenerId", "Targets" ] }, { "name": "DeregisterTargetsFromClassicalLB", "description": "DeregisterTargetsFromClassicalLB 接口用于解绑负载均衡后端服务。本接口为异步接口，接口返回成功后，需以返回的 RequestId 为入参，调用 DescribeTaskStatus 接口查询本次任务是否成功。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例ID。", "example": "lb-a3u5****" }, { "name": "InstanceIds", "type": "array", "required": true, "description": "后端服务的实例ID列表。", "example": "[\"ins-odjhn6vc\\r\\n\"]", "item_type": "string" } ], "required": [ "LoadBalancerId", "InstanceIds" ] }, { "name": "DescribeBlockIPList", "description": "查询一个负载均衡所封禁的IP列表（黑名单）。（接口灰度中，如需使用请提工单）", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例 ID。", "example": "lb-6efswuxa" }, { "name": "Offset", "type": "integer", "required": false, "description": "数据偏移量，默认为 0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回IP的最大个数，默认为 100000。", "example": "100000" } ], "required": [ "LoadBalancerId" ] }, { "name": "DescribeBlockIPTask", "description": "根据 ModifyBlockIPList 接口返回的异步任务的ID，查询封禁IP（黑名单）异步任务的执行状态。（接口灰度中，如需使用请提工单）", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "ModifyBlockIPList 接口返回的异步任务的ID。", "example": "localjob021015164373814322873" } ], "required": [ "TaskId" ] }, { "name": "DescribeClassicalLBByInstanceId", "description": "DescribeClassicalLBByInstanceId用于通过后端实例ID获取传统型负载均衡ID列表。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "后端实例ID列表。", "example": "[\"ins-odjhn6vc\\r\\n\"]", "item_type": "string" } ], "required": [ "InstanceIds" ] }, { "name": "DescribeClassicalLBHealthStatus", "description": "DescribeClassicalLBHealthStatus用于获取传统型负载均衡后端的健康状态", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例ID。", "example": "lb-a3u5****" }, { "name": "ListenerId", "type": "string", "required": false, "description": "负载均衡监听器ID。", "example": "lbl-0non****" } ], "required": [ "LoadBalancerId" ] }, { "name": "DescribeClassicalLBListeners", "description": "DescribeClassicalLBListeners 接口用于获取传统型负载均衡的监听器信息。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例ID。", "example": "lb-a3u5****" }, { "name": "ListenerIds", "type": "array", "required": false, "description": "负载均衡监听器ID列表。", "example": "[\"lbl-4fo6k8na\"]", "item_type": "string" }, { "name": "Protocol", "type": "string", "required": false, "description": "负载均衡监听的协议：'TCP', 'UDP', 'HTTP', 'HTTPS'。", "example": "TCP" }, { "name": "ListenerPort", "type": "integer", "required": false, "description": "负载均衡监听端口，范围为[1-65535]。", "example": "22" }, { "name": "Status", "type": "integer", "required": false, "description": "监听器的状态，0：创建中，1：运行中。", "example": "0" } ], "required": [ "LoadBalancerId" ] }, { "name": "DescribeClassicalLBTargets", "description": "DescribeClassicalLBTargets用于获取传统型负载均衡绑定的后端服务。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例 ID。", "example": "lb-a3u5l5zc" } ], "required": [ "LoadBalancerId" ] }, { "name": "DescribeClsLogSet", "description": "获取用户的CLB专有日志集。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeClusterResources", "description": "查询独占集群中的资源列表，支持按集群ID、VIP、负载均衡ID、是否闲置为过滤条件检索。", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回集群中资源列表数目，默认为20，最大值为100。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "返回集群中资源列表起始偏移量，默认为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "查询集群中资源列表条件，详细的过滤条件如下： cluster-id - String - 是否必填：否 - （过滤条件）按照 集群 的唯一ID过滤，如 ：\"tgw-12345678\",\"stgw-12345678\",\"vpcgw-12345678\"。 vip - String - 是否必填：否 - （过滤条件）按照vip过滤。 loadbalancer-id - String - 是否必填：否 - （过滤条件）按照负载均衡唯一ID过滤。 idle - String 是否必填：否 - （过滤条件）按照是否闲置过滤，如\"True\",\"False\"。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤器的名称", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "过滤器的值数组", "example": "[\"tke-clusterId\"]", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeCrossTargets", "description": "查询跨域2.0版本云联网后端子机和网卡信息。", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回后端服务列表数目，默认20，最大值100。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "返回后端服务列表起始偏移量，默认0。", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "查询跨域2.0版本云联网后端子机和网卡服务列表条件，详细的过滤条件如下： vpc-id - String - 是否必填：否 - （过滤条件）按照 本地私有网络ID，即负载均衡的VpcId 过滤，如：\"vpc-12345678\"。 ip - String - 是否必填：否 - （过滤条件）按照 后端服务ip 过滤，如：\"192.168.0.1\"。 listener-id - String - 是否必填：否 - （过滤条件）按照 监听器ID 过滤，如：\"lbl-12345678\"。 location-id - String - 是否必...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤器的名称", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "过滤器的值数组", "example": "[\"tke-clusterId\"]", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeCustomizedConfigAssociateList", "description": "拉取配置绑定的 server 或 location，如果 domain 存在，结果将根据 domain 过滤。或拉取配置绑定的 loadbalancer。", "status": "online", "parameters": [ { "name": "UconfigId", "type": "string", "required": false, "description": "配置ID，可以通过 [DescribeCustomizedConfigList](https://cloud.tencent.com/document/product/214/60009) 接口获取。", "example": "pz-fi018waq" }, { "name": "Offset", "type": "integer", "required": false, "description": "拉取绑定关系列表开始位置，默认值 0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "拉取绑定关系列表数目，默认值 20", "example": "3" }, { "name": "Domain", "type": "string", "required": false, "description": "搜索域名，可以通过 [DescribeLoadBalancersDetail](https://cloud.tencent.com/document/product/214/46916) 接口返回值的 `Domain` 字段查询。", "example": "a.cc" } ], "required": [] }, { "name": "DescribeCustomizedConfigList", "description": "拉取个性化配置列表，返回用户 AppId 下指定类型的配置。", "status": "online", "parameters": [ { "name": "ConfigType", "type": "string", "required": true, "description": "配置类型:CLB 负载均衡维度。 SERVER 域名维度。 LOCATION 规则维度。", "example": "CLB" }, { "name": "Offset", "type": "integer", "required": false, "description": "拉取页偏移，默认值0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "拉取数目，默认值20。", "example": "20" }, { "name": "ConfigName", "type": "string", "required": false, "description": "拉取指定配置名字，模糊匹配。", "example": "custom" }, { "name": "UconfigIds", "type": "array", "required": false, "description": "配置ID，可以通过 [DescribeCustomizedConfigList](https://cloud.tencent.com/document/api/214/60009) 接口查询。", "example": "pz-12345678", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件如下： - loadbalancer-id 按照【负载均衡 ID】进行过滤。实例计费模式例如：lb-9vxezxza。 类型：String 必选：否 获取方式：[DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459) - vip 按照【负载均衡VIP】进行过滤。网络计费模式例如：\"1.1.1.1\",\"2204::22:3\"。 类型：String 必选：否 获取方式：[DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459)", "example": "[{\"Name\":\"loadbalancer-id\",\"Values\":[\"lb-12345678\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤器的名称", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "过滤器的值数组", "example": "[\"tke-clusterId\"]", "item_type": "string" } ] } ], "required": [ "ConfigType" ] }, { "name": "DescribeExclusiveClusters", "description": "查询集群信息列表，支持以集群类型、集群唯一ID、集群名字、集群标签、集群内vip、集群内负载均衡唯一id、集群网络类型、可用区等条件进行检索", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回集群列表数目，默认值为20，最大值为100。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "返回集群列表起始偏移量，默认为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "查询集群列表条件，详细的过滤条件如下： cluster-type - String - 是否必填：否 - （过滤条件）按照 集群 的类型过滤，包括\"TGW\",\"STGW\",\"VPCGW\"。 cluster-id - String - 是否必填：否 - （过滤条件）按照 集群 的唯一ID过滤，如 ：\"tgw-12345678\",\"stgw-12345678\",\"vpcgw-12345678\"。 cluster-name - String - 是否必填：否 - （过滤条件）按照 集群 的名称过滤。 cluster-tag - String - 是否必填：否 - （过滤条件）按照...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤器的名称", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "过滤器的值数组", "example": "[\"tke-clusterId\"]", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeIdleLoadBalancers", "description": "闲置实例是指创建超过7天后付费实例，且没有创建规则或创建规则没有绑定子机的负载均衡实例。", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "数据偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回负载均衡实例的数量，默认为20，最大值为100。", "example": "20" }, { "name": "LoadBalancerRegion", "type": "string", "required": false, "description": "负载均衡所在地域，可以通过 [DescribeRegions](https://cloud.tencent.com/document/product/1596/77930) 接口返回值 `RegionSet.Region` 字段获取。", "example": "ap-guangzhou" } ], "required": [] }, { "name": "DescribeLBListeners", "description": "查询后端云主机或弹性网卡绑定的负载均衡，支持弹性网卡和cvm查询。", "status": "online", "parameters": [ { "name": "Backends", "type": "array", "required": true, "description": "需要查询的内网ip列表", "example": "无", "item_type": "object", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "vpc的字符串id，只支持字符串id。 可以通过 [DescribeVpcs](https://cloud.tencent.com/document/api/215/15778) 接口查询。", "example": "vpc-p5sf61yj" }, { "name": "PrivateIp", "type": "string", "required": true, "description": "需要查询后端的内网 IP，可以是 CVM 和弹性网卡。 可以通过 [DescribeAddresses](https://cloud.tencent.com/document/product/215/16702) 接口查询。", "example": "10.0.0.3" } ] } ], "required": [ "Backends" ] }, { "name": "DescribeLBOperateProtect", "description": "查询负载均衡的操作保护信息。", "status": "online", "parameters": [ { "name": "LoadBalancerIds", "type": "array", "required": true, "description": "负载均衡实例ID。", "example": "lb-ol9l5wxx", "item_type": "string" } ], "required": [ "LoadBalancerIds" ] }, { "name": "DescribeListeners", "description": "DescribeListeners 接口可根据负载均衡器 ID、监听器的协议或端口作为过滤条件获取监听器列表。如果不指定任何过滤条件，则返回该负载均衡实例下的所有监听器。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例 ID，可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/api/214/30685) 接口获取。", "example": "lb-aniq****" }, { "name": "ListenerIds", "type": "array", "required": false, "description": "要查询的负载均衡监听器 ID 数组，最大为100个，可以通过 [DescribeListeners](https://cloud.tencent.com/document/api/214/30686) 接口获取。", "example": "[\"lbl-8cnl****\",\"lbl-we2d\"]", "item_type": "string" }, { "name": "Protocol", "type": "string", "required": false, "description": "要查询的监听器协议类型，取值 TCP | UDP | HTTP | HTTPS | TCP_SSL | QUIC。", "example": "TCP" }, { "name": "Port", "type": "integer", "required": false, "description": "要查询的监听器的端口，端口范围：1-65535", "example": "23" } ], "required": [ "LoadBalancerId" ] }, { "name": "DescribeLoadBalancerListByCertId", "description": "根据证书ID查询其在一个地域中所关联到负载均衡实例列表", "status": "online", "parameters": [ { "name": "CertIds", "type": "array", "required": true, "description": "服务端证书的ID，或客户端证书的ID。可以通过 [DescribeCertificate](https://cloud.tencent.com/document/api/400/41674) 接口查询。 数组最大长度为20。", "example": "[\"RwFAfr8Y\"]", "item_type": "string" } ], "required": [ "CertIds" ] }, { "name": "DescribeLoadBalancerOverview", "description": "查询运行中、隔离中、即将到期和负载均衡总数。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeLoadBalancerTraffic", "description": "查询账号下的高流量负载均衡，返回前10个负载均衡。如果是子账号登录，只返回子账号有权限的负载均衡。", "status": "online", "parameters": [ { "name": "LoadBalancerRegion", "type": "string", "required": false, "description": "负载均衡所在地域，不传默认返回所有地域负载均衡。", "example": "ap-guangzhou" } ], "required": [] }, { "name": "DescribeLoadBalancers", "description": "查询一个地域的负载均衡实例列表。", "status": "online", "parameters": [ { "name": "LoadBalancerIds", "type": "array", "required": false, "description": "负载均衡实例ID。实例ID数量上限为20个。", "example": "[\"lb-rbw5****\"]", "item_type": "string" }, { "name": "LoadBalancerType", "type": "string", "required": false, "description": "负载均衡实例的网络类型： OPEN：公网属性， INTERNAL：内网属性。", "example": "OPEN" }, { "name": "Forward", "type": "integer", "required": false, "description": "负载均衡实例的类型。1：通用的负载均衡实例，0：传统型负载均衡实例。如果不传此参数，则查询所有类型的负载均衡实例。", "example": "1" }, { "name": "LoadBalancerName", "type": "string", "required": false, "description": "负载均衡实例的名称，支持模糊查询。", "example": "test_internal" }, { "name": "Domain", "type": "string", "required": false, "description": "腾讯云为负载均衡实例分配的域名，支持模糊查询。", "example": "lb-6m46rm32-se******o0q2g.clb.ap-guangzhou.testclb.com" }, { "name": "LoadBalancerVips", "type": "array", "required": false, "description": "负载均衡实例的 VIP 地址，支持多个。", "example": "[\"44.23.xxx.xxx\"]", "item_type": "string" }, { "name": "BackendPublicIps", "type": "array", "required": false, "description": "负载均衡绑定的后端服务的外网 IP，只支持查询云服务器的公网 IP。", "example": "[\"102.23.xxx.xxx\"]", "item_type": "string" }, { "name": "BackendPrivateIps", "type": "array", "required": false, "description": "负载均衡绑定的后端服务的内网 IP，只支持查询云服务器的内网 IP。", "example": "[\"172.16.xxx.xxx\"]", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "数据偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回负载均衡实例的数量，默认为20，最大值为100。", "example": "20" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序参数，支持以下字段： - LoadBalancerName - CreateTime - Domain - LoadBalancerType 默认为 CreateTime。", "example": "LoadBalancerName" }, { "name": "OrderType", "type": "integer", "required": false, "description": "1：倒序，0：顺序，默认为1，按照创建时间倒序。", "example": "0" }, { "name": "SearchKey", "type": "string", "required": false, "description": "模糊搜索字段，模糊匹配负载均衡实例的名称、域名、负载均衡实例的 VIP 地址，负载均衡实例ID。", "example": "test-name" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "负载均衡实例所属的项目 ID，可以通过[DescribeProject](https://cloud.tencent.com/document/api/651/78725)接口获取，不传默认所有项目。", "example": "1" }, { "name": "WithRs", "type": "integer", "required": false, "description": "负载均衡是否绑定后端服务，0：没有绑定后端服务，1：绑定后端服务，-1：查询全部。", "example": "-1" }, { "name": "VpcId", "type": "string", "required": false, "description": "负载均衡实例所属私有网络唯一ID，如 vpc-bhqkbhdx，可以通过[DescribeVpcs](https://cloud.tencent.com/document/api/215/15778)接口获取。 查找基础网络类型的负载均衡可传入'0'。", "example": "vpc-bhqk****" }, { "name": "SecurityGroup", "type": "string", "required": false, "description": "安全组ID，如 sg-m1cc****，可以通过接口[DescribeSecurityGroups](https://cloud.tencent.com/document/product/215/15808)获取。", "example": "sg-m1cc****" }, { "name": "MasterZone", "type": "string", "required": false, "description": "主可用区ID，如 ：\"100001\" （对应的是广州一区）。可通过[DescribeZones](https://cloud.tencent.com/document/product/213/15707)获取可用区列表。", "example": "100001" }, { "name": "Filters", "type": "array", "required": false, "description": "每次请求的`Filters`的上限为10，`Filter.Values`的上限为100。`Filter.Name`和`Filter.Values`皆为必填项。详细的过滤条件如下： - charge-type 按照【实例计费模式】进行过滤。实例计费模式例如：PREPAID。 类型：String 必选：否 可选项：PREPAID(预付费)、POSTPAID_BY_HOUR(后付费) - internet-charge-type 按照【网络计费模式】进行过滤。网络计费模式例如：BANDWIDTH_PREPAID。 类型：String 必选：否 可选项：BA...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤器的名称", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "过滤器的值数组", "example": "[\"tke-clusterId\"]", "item_type": "string" } ] }, { "name": "AdditionalFields", "type": "array", "required": false, "description": "选择返回的扩充字段，不指定时，扩充字段默认不返回。详细支持的扩充字段如下： TargetCount：绑定的后端服务数量", "example": "[\"TargetCount\"]", "item_type": "string" } ], "required": [] }, { "name": "DescribeLoadBalancersDetail", "description": "查询负载均衡的详细信息，包括监听器，规则及后端目标。", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回负载均衡列表数目，默认20，最大值100。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "返回负载均衡列表起始偏移量，默认0。", "example": "0" }, { "name": "Fields", "type": "array", "required": false, "description": "选择返回的Fields列表，系统仅会返回Fileds中填写的字段，可填写的字段详情请参见LoadBalancerDetail。若未在Fileds填写相关字段，则此字段返回null。Fileds中默认添加LoadBalancerId和LoadBalancerName字段。", "example": "[\"LoadBalancerId\",\"LoadBalancerName\"]", "item_type": "string" }, { "name": "TargetType", "type": "string", "required": false, "description": "当Fields包含TargetId、TargetAddress、TargetPort、TargetWeight、ListenerId、Protocol、Port、LocationId、Domain、Url等Fields时，必选选择导出目标组的Target或者非目标组Target，取值范围NODE、GROUP。", "example": "NODE" }, { "name": "Filters", "type": "array", "required": false, "description": "查询负载均衡详细信息列表条件，详细的过滤条件如下： - loadbalancer-id 按照【负载均衡ID】进行过滤。例如：lb-rbw5skde。 类型：String 必选：否 获取方式：[DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459) - project-id 按照【项目ID】进行过滤。例如： \"0\"、\"123\"。 类型：String 必选：否 获取方式：[DescribeProject](https://cloud.tencent.com/document/api/651/78725) - network 按照【负载均衡\ufffd\ufffd...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤器的名称", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "过滤器的值数组", "example": "[\"tke-clusterId\"]", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeQuota", "description": "查询用户当前地域下的各项配额", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeResources", "description": "查询用户在当前地域支持可用区列表和资源列表。", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回可用区资源列表数目，默认20，最大值100。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "返回可用区资源列表起始偏移量，默认0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "查询可用区资源列表条件，详细的过滤条件如下： - master-zone 按照【地域可用区】进行过滤，例如：ap-guangzhou-2。 类型：String 必选：否 - ip-version 按照【IP 类型】进行过滤，例如：IPv4。 类型：String 必选：否 可选项：IPv4、IPv6、IPv6_Nat - isp 按照【ISP 类型】进行过滤，例如：BGP。 类型：String 必选：否 可选项：BGP、CMCC（中国移动）、CUCC（中国联通）、CTCC（中国电信）、BGP_PRO、...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤器的名称", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "过滤器的值数组", "example": "[\"tke-clusterId\"]", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeRewrite", "description": "DescribeRewrite 接口可根据负载均衡实例ID，查询一个负载均衡实例下转发规则的重定向关系。如果不指定监听器ID或转发规则ID，则返回该负载均衡实例下的所有重定向关系。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例ID。", "example": "lb-qc2i****" }, { "name": "SourceListenerIds", "type": "array", "required": false, "description": "负载均衡监听器ID数组。", "example": "[\"lbl-j36caqde\\r\\n\"]", "item_type": "string" }, { "name": "SourceLocationIds", "type": "array", "required": false, "description": "负载均衡转发规则的ID数组。", "example": "[\"loc-5t7526km\\r\\n\"]", "item_type": "string" } ], "required": [ "LoadBalancerId" ] }, { "name": "DescribeTargetGroupInstanceStatus", "description": "查询目标组后端服务状态。目前仅支持网关负载均衡类型的目标组支持查询后端服务状态。", "status": "online", "parameters": [ { "name": "TargetGroupId", "type": "string", "required": true, "description": "目标组唯一id", "example": "lbtg-xxx" }, { "name": "TargetGroupInstanceIps", "type": "array", "required": false, "description": "目标组绑定的后端服务ip列表", "example": "[\"10.0.0.1\"]", "item_type": "string" } ], "required": [ "TargetGroupId" ] }, { "name": "DescribeTargetGroupInstances", "description": "获取目标组绑定的服务器信息", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": true, "description": "过滤条件，当前支持按照 TargetGroupId，BindIP，InstanceId 多个条件组合过滤。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤器的名称", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "过滤器的值数组", "example": "[\"tke-clusterId\"]", "item_type": "string" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "显示数量限制，默认20。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "显示的偏移量，默认为0。", "example": "0" } ], "required": [ "Filters" ] }, { "name": "DescribeTargetGroupList", "description": "获取目标组列表", "status": "online", "parameters": [ { "name": "TargetGroupIds", "type": "array", "required": false, "description": "目标组ID数组。", "example": "[\"lbtg-5xu****\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件数组，支持TargetGroupVpcId和TargetGroupName。与TargetGroupIds互斥，优先使用目标组ID。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤器的名称", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "过滤器的值数组", "example": "[\"tke-clusterId\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "显示的偏移起始量。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页显示条目数。取值范围：[0, 100]默认值：20", "example": "20" } ], "required": [] }, { "name": "DescribeTargetGroups", "description": "查询目标组信息", "status": "online", "parameters": [ { "name": "TargetGroupIds", "type": "array", "required": false, "description": "目标组ID，与Filters互斥。", "example": "[\"lbtg-5xunivs0\"]", "item_type": "string" }, { "name": "Limit", "type": "integer", "required": false, "description": "显示条数限制，默认为20。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "显示的偏移起始量。", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件数组，与TargetGroupIds互斥，支持 TargetGroupVpcId（私有网络 ID）和 TargetGroupName（目标组名称）以及 Tag（标签）。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤器的名称", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "过滤器的值数组", "example": "[\"tke-clusterId\"]", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeTargetHealth", "description": "DescribeTargetHealth 接口用来获取负载均衡后端服务的健康检查结果，不支持传统型负载均衡。", "status": "online", "parameters": [ { "name": "LoadBalancerIds", "type": "array", "required": true, "description": "要查询的负载均衡实例ID列表。", "example": "[\"lb-qc2iq5yc\"]", "item_type": "string" }, { "name": "ListenerIds", "type": "array", "required": false, "description": "要查询的监听器ID列表。", "example": "[\"lbl-cpu5e38u\"]", "item_type": "string" }, { "name": "LocationIds", "type": "array", "required": false, "description": "要查询的转发规则ID列表。", "example": "[\"loc-q41gixxq\"]", "item_type": "string" } ], "required": [ "LoadBalancerIds" ] }, { "name": "DescribeTargets", "description": "DescribeTargets 接口用来查询负载均衡实例的某些监听器绑定的后端服务列表。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例 ID。", "example": "lb-10iq9lou" }, { "name": "ListenerIds", "type": "array", "required": false, "description": "监听器 ID 列表。ID 数量上限为20个。", "example": "[\"lbl-4fo6k8na\"]", "item_type": "string" }, { "name": "Protocol", "type": "string", "required": false, "description": "监听器协议类型。", "example": "HTTP" }, { "name": "Port", "type": "integer", "required": false, "description": "监听器端口。", "example": "80" }, { "name": "Filters", "type": "array", "required": false, "description": "查询负载均衡绑定的后端服务列表，过滤条件如下： location-id - String - 是否必填：否 - （过滤条件）按照 规则ID 过滤，如：\"loc-12345678\"。 private-ip-address - String - 是否必填：否 - （过滤条件）按照 后端服务内网IP 过滤，如：\"172.16.1.1\"。 tag - String - 是否必填：否 - （过滤条件）按照 标签 过滤，如：\"tag-test\"。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤器的名称", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "过滤器的值数组", "example": "[\"tke-clusterId\"]", "item_type": "string" } ] } ], "required": [ "LoadBalancerId" ] }, { "name": "DescribeTaskStatus", "description": "本接口用于查询异步任务的执行状态，对于非查询类的接口（创建/删除负载均衡实例、监听器、规则以及绑定或解绑后端服务等），在接口调用成功后，都需要使用本接口查询任务最终是否执行成功。", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": false, "description": "请求ID，即接口返回的 RequestId 参数。", "example": "55c85074-3e7f-4c6d-864f-673660d4f8de" }, { "name": "DealName", "type": "string", "required": false, "description": "订单ID。 注意：参数TaskId和DealName必须传一个。", "example": "2022XXXX" } ], "required": [] }, { "name": "DisassociateCustomizedConfig", "description": "去关联个性化配置，准备下线，请使用SetCustomizedConfigForLoadBalancer。", "status": "online", "parameters": [ { "name": "UconfigId", "type": "string", "required": true, "description": "配置ID", "example": "pz-ched**vd" }, { "name": "BindList", "type": "array", "required": true, "description": "解绑的列表", "example": "无", "item_type": "object", "children": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "配置绑定的CLB ID", "example": "lb-6e6a****" }, { "name": "ListenerId", "type": "string", "required": true, "description": "配置绑定的监听器ID", "example": "lbl-cuxw****" }, { "name": "Domain", "type": "string", "required": true, "description": "配置绑定的域名", "example": "www.test.com" }, { "name": "LocationId", "type": "string", "required": false, "description": "配置绑定的规则", "example": "loc-4apy****" } ] } ], "required": [ "UconfigId", "BindList" ] }, { "name": "DisassociateTargetGroups", "description": "解除规则的目标组关联关系。 本接口为异步接口，本接口返回成功后需以返回的 RequestID 为入参，调用 DescribeTaskStatus 接口查询本次任务是否成功。 当解绑七层转发规则时，LocationId 为必填项。", "status": "online", "parameters": [ { "name": "Associations", "type": "array", "required": true, "description": "待解绑的规则关系数组，支持批量解绑多个监听器，单次批量解除最多20个。", "example": "无", "item_type": "object", "children": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡ID", "example": "lb-agcadfe" }, { "name": "TargetGroupId", "type": "string", "required": true, "description": "目标组ID", "example": "lbtg-0nzo3czo" }, { "name": "ListenerId", "type": "string", "required": false, "description": "监听器ID。访问AssociateTargetGroups和DisassociateTargetGroups接口时必传此参数。", "example": "lbl-xxxx" }, { "name": "LocationId", "type": "string", "required": false, "description": "转发规则ID", "example": "loc-aaaaaa" }, { "name": "Weight", "type": "integer", "required": false, "description": "目标组权重，范围[0, 100]。仅绑定v2目标组时生效，如果不存在，则默认为10。", "example": "100" } ] } ], "required": [ "Associations" ] }, { "name": "InquiryPriceCreateLoadBalancer", "description": "InquiryPriceCreateLoadBalancer接口查询创建负载均衡的价格。", "status": "online", "parameters": [ { "name": "LoadBalancerType", "type": "string", "required": true, "description": "询价的负载均衡类型，OPEN为公网类型，INTERNAL为内网类型", "example": "OPEN" }, { "name": "LoadBalancerChargeType", "type": "string", "required": true, "description": "询价的收费类型，POSTPAID为按量计费，\"PREPAID\"为预付费包年包月", "example": "POSTPAID" }, { "name": "LoadBalancerChargePrepaid", "type": "object", "required": false, "description": "询价的收费周期。（仅包年包月支持该参数）", "example": "无", "children": [ { "name": "RenewFlag", "type": "string", "required": false, "description": "续费类型：AUTO_RENEW 自动续费， MANUAL_RENEW 手动续费", "example": "AUTO_RENEW" }, { "name": "Period", "type": "integer", "required": false, "description": "购买时长，单位：月", "example": "1" } ] }, { "name": "InternetAccessible", "type": "object", "required": false, "description": "询价的网络计费方式", "example": "无", "children": [ { "name": "InternetChargeType", "type": "string", "required": false, "description": "TRAFFIC_POSTPAID_BY_HOUR 按流量按小时后计费 ; BANDWIDTH_POSTPAID_BY_HOUR 按带宽按小时后计费，国际站用户不支持该计费模式; BANDWIDTH_PACKAGE 按带宽包计费;BANDWIDTH_PREPAID按带宽预付费。", "example": "BANDWIDTH_POSTPAID_BY_HOUR" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "最大出带宽，单位Mbps，仅对公网属性的共享型、性能容量型和独占型 CLB 实例、以及内网属性的性能容量型 CLB 实例生效。 - 对于公网属性的共享型和独占型 CLB 实例，最大出带宽的范围为1Mbps-2048Mbps。 - 对于公网属性和内网属性的性能容量型 CLB实例，最大出带宽的范围为1Mbps-61440Mbps。 （调用CreateLoadBalancer创建LB时不指定此参数则设置为默认值10Mbps。此上限可调整）", "example": "1" }, { "name": "BandwidthpkgSubType", "type": "string", "required": false, "description": "带宽包的类型，如 BGP（多线）。 类型如下： SINGLEISP: 单线 BGP: 多线 HIGH_QUALITY_BGP: 精品BGP共享带宽包 SINGLEISP_CMCC: 中国移动共享带宽包 SINGLEISP_CTCC: 中国电信共享带宽包 SINGLEISP_CUCC: 中国联通共享带宽包 注意：此字段可能返回 null，表示取不到有效值。", "example": "SINGLEISP" } ] }, { "name": "GoodsNum", "type": "integer", "required": false, "description": "询价的负载均衡实例个数，默认为1", "example": "1" }, { "name": "ZoneId", "type": "string", "required": false, "description": "指定可用区询价。如：ap-guangzhou-1", "example": "ap-guangzhou-1" }, { "name": "SlaType", "type": "string", "required": false, "description": "包年包月询价时传性能容量型规格，如：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） 按量付费询价时传SLA", "example": "clb.c3.small" }, { "name": "AddressIPVersion", "type": "string", "required": false, "description": "IP版本，可取值：IPV4、IPV6、IPv6FullChain，不区分大小写，默认值 IPV4。说明：取值为IPV6表示为IPV6 NAT64版本；取值为IPv6FullChain，表示为IPv6版本。", "example": "IPV4" }, { "name": "VipIsp", "type": "string", "required": false, "description": "仅适用于公网负载均衡。目前仅广州、上海、南京、济南、杭州、福州、北京、石家庄、武汉、长沙、成都、重庆地域支持静态单线 IP 线路类型，如需体验，请联系商务经理申请。申请通过后，即可选择中国移动（CMCC）、中国联通（CUCC）或中国电信（CTCC）的运营商类型，网络计费模式只能使用按带宽包计费(BANDWIDTH_PACKAGE)。 如果不指定本参数，则默认使用BGP。可通过 DescribeRe...", "example": "CMCC" } ], "required": [ "LoadBalancerType", "LoadBalancerChargeType" ] }, { "name": "InquiryPriceModifyLoadBalancer", "description": "InquiryPriceModifyLoadBalancer接口修改负载均衡配置询价。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例 ID，可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459) 接口查询。", "example": "lb-dr0mo6w4" }, { "name": "InternetAccessible", "type": "object", "required": true, "description": "修改后的网络带宽信息", "example": "无", "children": [ { "name": "InternetChargeType", "type": "string", "required": false, "description": "TRAFFIC_POSTPAID_BY_HOUR 按流量按小时后计费 ; BANDWIDTH_POSTPAID_BY_HOUR 按带宽按小时后计费，国际站用户不支持该计费模式; BANDWIDTH_PACKAGE 按带宽包计费;BANDWIDTH_PREPAID按带宽预付费。", "example": "BANDWIDTH_POSTPAID_BY_HOUR" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "最大出带宽，单位Mbps，仅对公网属性的共享型、性能容量型和独占型 CLB 实例、以及内网属性的性能容量型 CLB 实例生效。 - 对于公网属性的共享型和独占型 CLB 实例，最大出带宽的范围为1Mbps-2048Mbps。 - 对于公网属性和内网属性的性能容量型 CLB实例，最大出带宽的范围为1Mbps-61440Mbps。 （调用CreateLoadBalancer创建LB时不指定此参数则设置为默认值10Mbps。此上限可调整）", "example": "1" }, { "name": "BandwidthpkgSubType", "type": "string", "required": false, "description": "带宽包的类型，如 BGP（多线）。 类型如下： SINGLEISP: 单线 BGP: 多线 HIGH_QUALITY_BGP: 精品BGP共享带宽包 SINGLEISP_CMCC: 中国移动共享带宽包 SINGLEISP_CTCC: 中国电信共享带宽包 SINGLEISP_CUCC: 中国联通共享带宽包 注意：此字段可能返回 null，表示取不到有效值。", "example": "SINGLEISP" } ] } ], "required": [ "LoadBalancerId", "InternetAccessible" ] }, { "name": "InquiryPriceRefundLoadBalancer", "description": "InquiryPriceRefundLoadBalancer接口查询负载均衡退费价格，只支持预付费类型的负载均衡实例。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例ID。可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459) 接口查询。", "example": "lb-eth6my23" } ], "required": [ "LoadBalancerId" ] }, { "name": "InquiryPriceRenewLoadBalancer", "description": "InquiryPriceRenewLoadBalancer接口查询对负载均衡续费的价格，只支持预付费负载均衡续费。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例 ID，可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459) 接口查询。", "example": "lb-xxxxxxxx" }, { "name": "LoadBalancerChargePrepaid", "type": "object", "required": true, "description": "续费周期", "example": "无", "children": [ { "name": "RenewFlag", "type": "string", "required": false, "description": "续费类型：AUTO_RENEW 自动续费， MANUAL_RENEW 手动续费", "example": "AUTO_RENEW" }, { "name": "Period", "type": "integer", "required": false, "description": "购买时长，单位：月", "example": "1" } ] } ], "required": [ "LoadBalancerId", "LoadBalancerChargePrepaid" ] }, { "name": "ManualRewrite", "description": "用户手动配置原访问地址和重定向地址，系统自动将原访问地址的请求重定向至对应路径的目的地址。同一域名下可以配置多条路径作为重定向策略，实现http/https之间请求的自动跳转。设置重定向时，需满足如下约束条件：若A已经重定向至B，则A不能再重定向至C（除非先删除老的重定向关系，再建立新的重定向关系），B不能重定向至任何其它地址。 本接口为异步接口，本接\ufffd...", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例 ID。", "example": "lb-51jj****" }, { "name": "SourceListenerId", "type": "string", "required": true, "description": "源监听器 ID。", "example": "lbl-0non****" }, { "name": "TargetListenerId", "type": "string", "required": true, "description": "目标监听器 ID。", "example": "lbl-r4ia****" }, { "name": "RewriteInfos", "type": "array", "required": true, "description": "转发规则之间的重定向关系。", "example": "无", "item_type": "object", "children": [ { "name": "SourceLocationId", "type": "string", "required": true, "description": "源转发规则ID", "example": "loc-i82k****" }, { "name": "TargetLocationId", "type": "string", "required": true, "description": "重定向目标转发规则的ID", "example": "loc-lavx****" }, { "name": "RewriteCode", "type": "integer", "required": false, "description": "重定向状态码，可取值301,302,307", "example": "302" }, { "name": "TakeUrl", "type": "boolean", "required": false, "description": "重定向是否携带匹配的url，配置RewriteCode时必填", "example": "true" }, { "name": "SourceDomain", "type": "string", "required": false, "description": "源转发的域名，必须是SourceLocationId对应的域名，配置RewriteCode时必填", "example": "xxx.com" } ] } ], "required": [ "LoadBalancerId", "SourceListenerId", "TargetListenerId", "RewriteInfos" ] }, { "name": "MigrateClassicalLoadBalancers", "description": "本接口将传统型负载均衡迁移成(原应用型)负载均衡 本接口为异步接口，接口成功返回后，可使用 DescribeLoadBalancers 接口查询负载均衡实例的状态（如创建中、正常），以确定是否创建成功。", "status": "online", "parameters": [ { "name": "LoadBalancerIds", "type": "array", "required": true, "description": "传统型负载均衡ID数组", "example": "[\"lb-isdw5mum\\r\\n\"]", "item_type": "string" }, { "name": "ExclusiveCluster", "type": "object", "required": false, "description": "独占集群信息", "example": "无", "children": [ { "name": "L4Clusters", "type": "array", "required": false, "description": "4层独占集群列表 注意：此字段可能返回 null，表示取不到有效值。", "item_type": "object", "children": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群唯一ID", "example": "tgw-p1zxs4fu" }, { "name": "ClusterName", "type": "string", "required": false, "description": "集群名称", "example": "guangzhou-zone4-M6-S4-40G-CAP-CLB-TPNS-SET1" }, { "name": "Zone", "type": "string", "required": false, "description": "集群所在可用区，如ap-guangzhou-1 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-guangzhou-1" } ] }, { "name": "L7Clusters", "type": "array", "required": false, "description": "7层独占集群列表 注意：此字段可能返回 null，表示取不到有效值。", "item_type": "object", "children": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群唯一ID", "example": "tgw-p1zxs4fu" }, { "name": "ClusterName", "type": "string", "required": false, "description": "集群名称", "example": "guangzhou-zone4-M6-S4-40G-CAP-CLB-TPNS-SET1" }, { "name": "Zone", "type": "string", "required": false, "description": "集群所在可用区，如ap-guangzhou-1 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-guangzhou-1" } ] }, { "name": "ClassicalCluster", "type": "object", "required": false, "description": "vpcgw集群 注意：此字段可能返回 null，表示取不到有效值。", "children": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群唯一ID", "example": "tgw-p1zxs4fu" }, { "name": "ClusterName", "type": "string", "required": false, "description": "集群名称", "example": "guangzhou-zone4-M6-S4-40G-CAP-CLB-TPNS-SET1" }, { "name": "Zone", "type": "string", "required": false, "description": "集群所在可用区，如ap-guangzhou-1 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-guangzhou-1" } ] } ] } ], "required": [ "LoadBalancerIds" ] }, { "name": "ModifyBlockIPList", "description": "修改负载均衡的IP（client IP）封禁黑名单列表，一个转发规则最多支持封禁 2000000 个IP，及黑名单容量为 2000000。 （接口灰度中，如需使用请提工单）", "status": "online", "parameters": [ { "name": "LoadBalancerIds", "type": "array", "required": true, "description": "负载均衡实例ID", "example": "[\"lb-4ic3ls9w\"]", "item_type": "string" }, { "name": "Type", "type": "string", "required": true, "description": "操作类型，可取： add_customized_field（首次设置header，开启黑名单功能） set_customized_field（修改header） del_customized_field（删除header） add_blocked（添加黑名单） del_blocked（删除黑名单） flush_blocked（清空黑名单）", "example": "add_customized_field" }, { "name": "ClientIPField", "type": "string", "required": true, "description": "客户端真实IP存放的header字段名", "example": "X-Real-IP" }, { "name": "BlockIPList", "type": "array", "required": false, "description": "封禁IP列表，单次操作数组最大长度支持200000", "example": "[\"208.247.90.70\"]", "item_type": "string" }, { "name": "ExpireTime", "type": "integer", "required": false, "description": "过期时间，单位秒，默认值3600", "example": "2025-12-06 15:26:22" }, { "name": "AddStrategy", "type": "string", "required": false, "description": "添加IP的策略，可取：fifo（如果黑名单容量已满，新加入黑名单的IP采用先进先出策略）", "example": "fifo" } ], "required": [ "LoadBalancerIds", "Type", "ClientIPField" ] }, { "name": "ModifyDomain", "description": "ModifyDomain接口用来修改负载均衡七层监听器下的域名。 本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例 ID，可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。", "example": "lb-cuxw2rm0" }, { "name": "ListenerId", "type": "string", "required": true, "description": "负载均衡监听器 ID， 可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。", "example": "lbl-d1ubsydq" }, { "name": "Domain", "type": "string", "required": true, "description": "监听器下的某个旧域名， 可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 查询。", "example": "foo.net" }, { "name": "NewDomain", "type": "string", "required": true, "description": "新域名， 长度限制为：1-120。有三种使用格式：非正则表达式格式，通配符格式，正则表达式格式。非正则表达式格式只能使用字母、数字、‘-’、‘.’。通配符格式的使用 ‘*’ 只能在开头或者结尾。正则表达式以'~'开头。", "example": "bar.net" } ], "required": [ "LoadBalancerId", "ListenerId", "Domain", "NewDomain" ] }, { "name": "ModifyDomainAttributes", "description": "ModifyDomainAttributes接口用于修改负载均衡7层监听器转发规则的域名级别属性，如修改域名、修改DefaultServer、开启/关闭Http2、修改证书 本接口为异步接口，本接口返回成功后，需以返回的RequestId为入参，调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例ID，可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。", "example": "lb-1wvl****" }, { "name": "ListenerId", "type": "string", "required": true, "description": "负载均衡监听器ID，可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。", "example": "lbl-n8mb****" }, { "name": "Domain", "type": "string", "required": true, "description": "域名（必须是已经创建的转发规则下的域名），如果是多域名，可以指定多域名列表中的任意一个，可以通过[DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。", "example": "foo.net" }, { "name": "NewDomain", "type": "string", "required": false, "description": "要修改的新域名。NewDomain和NewDomains只能传一个。", "example": "www.new.example.com" }, { "name": "Certificate", "type": "object", "required": false, "description": "域名相关的证书信息，注意，仅对启用SNI的监听器适用，不可和MultiCertInfo 同时传入。", "example": "无", "children": [ { "name": "SSLMode", "type": "string", "required": false, "description": "认证类型，UNIDIRECTIONAL：单向认证，MUTUAL：双向认证。 默认为 UNIDIRECTIONAL。", "example": "UNIDIRECTIONAL" }, { "name": "SSLVerifyClient", "type": "string", "required": false, "description": "双向认证时，是否开启客户端认证，ON:开启，OPTIONAL:自适应，默认ON。", "example": "ON" }, { "name": "CertId", "type": "string", "required": false, "description": "服务端证书的 ID，如果不填写此项则必须上传证书，包括 CertContent（服务端证书内容），CertKey（服务端证书密钥），CertName（服务端证书名称）。", "example": "Fm8Wpag8" }, { "name": "CertCaId", "type": "string", "required": false, "description": "客户端证书的 ID，当监听器采用双向认证，即 SSLMode=MUTUAL 时，如果不填写此项则必须上传客户端证书，包括 CertCaContent，CertCaName。", "example": "HcsGe9BH" }, { "name": "CertName", "type": "string", "required": false, "description": "上传服务端证书的名称，如果没有 CertId，则此项必传。", "example": "NewCert" }, { "name": "CertKey", "type": "string", "required": false, "description": "上传服务端证书的 key，如果没有 CertId，则此项必传。", "example": "-----BEGIN RSA PRIVATE KEY----- certkey -----END RSA PRIVATE KEY-----" }, { "name": "CertContent", "type": "string", "required": false, "description": "上传服务端证书的内容，如果没有 CertId，则此项必传。", "example": "-----BEGIN CERTIFICATE----- certcontent -----END CERTIFICATE" }, { "name": "CertCaName", "type": "string", "required": false, "description": "上传客户端 CA 证书的名称，如果 SSLMode=MUTUAL，如果没有 CertCaId，则此项必传。", "example": "new_certca" }, { "name": "CertCaContent", "type": "string", "required": false, "description": "上传客户端证书的内容，如果 SSLMode=MUTUAL，如果没有 CertCaId，则此项必传。", "example": "-----BEGIN CERTIFICATE----- certcontent -----END CERTIFICATE" } ] }, { "name": "Http2", "type": "boolean", "required": false, "description": "是否开启HTTP2，注意，只有HTTPS域名才能开启HTTP2。 True: 开启HTTP2，Fasle: 不开启HTTP2。", "example": "True" }, { "name": "DefaultServer", "type": "boolean", "required": false, "description": "是否设为默认域名，注意，一个监听器下只能设置一个默认域名。 True: 设为默认域名，Fasle: 不设置为默认域名。", "example": "True" }, { "name": "Quic", "type": "boolean", "required": false, "description": "是否开启 QUIC，注意，只有 HTTPS 域名才能开启 QUIC。 True: 开启 QUIC，False: 不开启QUIC。", "example": "True" }, { "name": "NewDefaultServerDomain", "type": "string", "required": false, "description": "监听器下必须配置一个默认域名，若要关闭原默认域名，必须同时指定另一个域名作为新的默认域名，如果新的默认域名是多域名，可以指定多域名列表中的任意一个。", "example": "www.qcloud.example.com" }, { "name": "NewDomains", "type": "array", "required": false, "description": "要修改的新域名列表。NewDomain和NewDomains只能传一个。", "example": "[\"www.new.example.com\"]", "item_type": "string" }, { "name": "MultiCertInfo", "type": "object", "required": false, "description": "域名相关的证书信息，注意，仅对启用SNI的监听器适用；支持同时传入多本算法类型不同的服务器证书，不可和Certificate 同时传入。", "example": "无", "children": [ { "name": "SSLMode", "type": "string", "required": true, "description": "认证类型，UNIDIRECTIONAL：单向认证，MUTUAL：双向认证", "example": "UNIDIRECTIONAL" }, { "name": "CertList", "type": "array", "required": true, "description": "监听器或规则证书列表，单双向认证，多本服务端证书算法类型不能重复;若SSLMode为双向认证，证书列表必须包含一本ca证书。", "example": "见起类型示例", "item_type": "object", "children": [ { "name": "CertId", "type": "string", "required": false, "description": "证书 ID，如果不填写此项则必须上传证书内容，包括CertName, CertContent，若为服务端证书必须包含CertKey。", "example": "zFzZAAIr" }, { "name": "CertName", "type": "string", "required": false, "description": "上传证书的名称，如果没有 CertId，则此项必传。", "example": "tes-cert" }, { "name": "CertContent", "type": "string", "required": false, "description": "上传证书的公钥；如果没有 CertId，则此项必传。", "example": " -----BEGIN CERTIFICATE-----" }, { "name": "CertKey", "type": "string", "required": false, "description": "上传服务端证书的私钥；如果没有 CertId，则此项必传。", "example": "-----BEGIN RSA PRIVATE KEY----- " } ] }, { "name": "SSLVerifyClient", "type": "string", "required": false, "description": "双向认证时，是否开启客户端认证，ON:开启，OPTIONAL:自适应，默认ON", "example": "ON" } ] } ], "required": [ "LoadBalancerId", "ListenerId", "Domain" ] }, { "name": "ModifyFunctionTargets", "description": "修改负载均衡转发规则上所绑定的云函数。 限制说明： - 仅支持绑定“Event 函数”类型的云函数。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例ID。", "example": "lb-1234abcd" }, { "name": "ListenerId", "type": "string", "required": true, "description": "负载均衡监听器ID。", "example": "lbl-1234tgbh" }, { "name": "FunctionTargets", "type": "array", "required": true, "description": "要修改的后端云函数服务列表，仅支持 Event 函数类型。", "example": "无", "item_type": "object", "children": [ { "name": "Function", "type": "object", "required": true, "description": "云函数相关信息", "example": "无", "children": [ { "name": "FunctionNamespace", "type": "string", "required": true, "description": "函数命名空间", "example": "default" }, { "name": "FunctionName", "type": "string", "required": true, "description": "函数名称", "example": "bxs-open-api" }, { "name": "FunctionQualifier", "type": "string", "required": true, "description": "函数的版本名称或别名", "example": "$LATEST" }, { "name": "FunctionQualifierType", "type": "string", "required": false, "description": "标识 FunctionQualifier 参数的类型，可取值： VERSION（版本）、ALIAS（别名） 注意：此字段可能返回 null，表示取不到有效值。", "example": "VERSION" } ] }, { "name": "Weight", "type": "integer", "required": false, "description": "权重", "example": "10" } ] }, { "name": "LocationId", "type": "string", "required": false, "description": "转发规则的ID，当绑定机器到七层转发规则时，必须提供此参数或Domain+Url两者之一。", "example": "loc-1234rrrr" }, { "name": "Domain", "type": "string", "required": false, "description": "目标规则的域名，提供LocationId参数时本参数不生效。", "example": "www.123.com" }, { "name": "Url", "type": "string", "required": false, "description": "目标规则的URL，提供LocationId参数时本参数不生效。", "example": "/test" } ], "required": [ "LoadBalancerId", "ListenerId", "FunctionTargets" ] }, { "name": "ModifyListener", "description": "ModifyListener接口用来修改负载均衡监听器的属性，包括监听器名称、健康检查参数、证书信息、转发策略等。本接口不支持传统型负载均衡。 本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例ID，可以通过 DescribeLoadBalancers 接口查询。", "example": "lb-cuxw****" }, { "name": "ListenerId", "type": "string", "required": true, "description": "负载均衡监听器ID，可以通过 DescribeListeners 接口查询。", "example": "lbl-d1ub****" }, { "name": "ListenerName", "type": "string", "required": false, "description": "新的监听器名称。命名规则：1-80 个英文字母、汉字等国际通用语言字符，数字，连接线“-”、下划线“_”等常见字符（禁止Unicode补充字符，如emoji表情、生僻汉字等）。", "example": "newlis" }, { "name": "SessionExpireTime", "type": "integer", "required": false, "description": "会话保持时间，单位：秒。可选值：30~3600，默认 0，表示不开启。此参数仅适用于TCP/UDP监听器。", "example": "120" }, { "name": "HealthCheck", "type": "object", "required": false, "description": "健康检查相关参数，此参数仅适用于TCP/UDP/TCP_SSL/QUIC监听器。", "example": "无", "children": [ { "name": "HealthSwitch", "type": "integer", "required": false, "description": "是否开启健康检查：1（开启）、0（关闭）。 默认为开启。", "example": "0" }, { "name": "TimeOut", "type": "integer", "required": false, "description": "健康检查的响应超时时间，可选值：2~60，默认值：2，单位：秒。响应超时时间要小于检查间隔时间。", "example": "2" }, { "name": "IntervalTime", "type": "integer", "required": false, "description": "健康检查探测间隔时间，默认值：5，IPv4 CLB实例的取值范围为：2-300，IPv6 CLB 实例的取值范围为：5-300。单位：秒。 说明：部分老旧 IPv4 CLB实例的取值范围为：5-300。", "example": "5" }, { "name": "HealthNum", "type": "integer", "required": false, "description": "健康阈值，默认值：3，表示当连续探测三次健康则表示该转发正常，可选值：2~10，单位：次。", "example": "3" }, { "name": "UnHealthNum", "type": "integer", "required": false, "description": "不健康阈值，默认值：3，表示当连续探测三次不健康则表示该转发异常，可选值：2~10，单位：次。", "example": "3" }, { "name": "HttpCode", "type": "integer", "required": false, "description": "健康检查状态码（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式）。可选值：1~31，默认 31。 1 表示探测后返回值 1xx 代表健康，2 表示返回 2xx 代表健康，4 表示返回 3xx 代表健康，8 表示返回 4xx 代表健康，16 表示返回 5xx 代表健康。若希望多种返回码都可代表健康，则将相应的值相加。 注意：此字段可能返回 null，表示取不到有效值。", "example": "8" }, { "name": "HttpCheckPath", "type": "string", "required": false, "description": "健康检查路径（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "/xxx" }, { "name": "HttpCheckDomain", "type": "string", "required": false, "description": "健康检查域名，将在HTTP协议 Host 头字段中携带。（仅适用于HTTP/HTTPS监听器和TCP监听器的HTTP健康检查方式。针对TCP监听器，当使用HTTP健康检查方式时，该参数为必填项）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "www.xxxx.com" }, { "name": "HttpCheckMethod", "type": "string", "required": false, "description": "健康检查方法（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式），默认值：HEAD，可选值HEAD或GET。 注意：此字段可能返回 null，表示取不到有效值。", "example": "HEAD" }, { "name": "CheckPort", "type": "integer", "required": false, "description": "自定义探测相关参数。健康检查端口，默认为后端服务的端口，除非您希望指定特定端口，否则建议留空。传参数值-1可恢复默认设置。（仅适用于TCP/UDP监听器）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "8000" }, { "name": "ContextType", "type": "string", "required": false, "description": "自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查的输入格式，可取值：HEX或TEXT；取值为HEX时，SendContext和RecvContext的字符只能在0123456789ABCDEF中选取且长度必须是偶数位。（仅适用于TCP/UDP监听器） 注意：此字段可能返回 null，表示取不到有效值。", "example": "TEXT" }, { "name": "SendContext", "type": "string", "required": false, "description": "自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查发送的请求内容，只允许ASCII可见字符，最大长度限制500。（仅适用于TCP/UDP监听器）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "request-info" }, { "name": "RecvContext", "type": "string", "required": false, "description": "自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查返回的结果，只允许ASCII可见字符，最大长度限制500。（仅适用于TCP/UDP监听器）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "response-info" }, { "name": "CheckType", "type": "string", "required": false, "description": "健康检查使用的协议。取值 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默认值与后端转发协议一致。", "example": "HTTP" }, { "name": "HttpVersion", "type": "string", "required": false, "description": "HTTP版本。健康检查协议CheckType的值取HTTP时，必传此字段，代表后端服务的HTTP版本：HTTP/1.0、HTTP/1.1；（仅适用于TCP监听器） 注意：此字段可能返回 null，表示取不到有效值。", "example": "HTTP/1.1" }, { "name": "SourceIpType", "type": "integer", "required": false, "description": "健康检查源IP类型：0（使用LB的VIP作为源IP），1（使用100.64网段IP作为源IP）。", "example": "0" }, { "name": "ExtendedCode", "type": "string", "required": false, "description": "GRPC健康检查状态码（仅适用于后端转发协议为GRPC的规则）。默认值为 12，可输入值为数值、多个数值、或者范围，例如 20 或 20,25 或 0-99 注意：此字段可能返回 null，表示取不到有效值。", "example": "12" } ] }, { "name": "Certificate", "type": "object", "required": false, "description": "证书相关信息，此参数仅适用于HTTPS/TCP_SSL/QUIC监听器；此参数和MultiCertInfo不能同时传入。", "example": "无", "children": [ { "name": "SSLMode", "type": "string", "required": false, "description": "认证类型，UNIDIRECTIONAL：单向认证，MUTUAL：双向认证。 默认为 UNIDIRECTIONAL。", "example": "UNIDIRECTIONAL" }, { "name": "SSLVerifyClient", "type": "string", "required": false, "description": "双向认证时，是否开启客户端认证，ON:开启，OPTIONAL:自适应，默认ON。", "example": "ON" }, { "name": "CertId", "type": "string", "required": false, "description": "服务端证书的 ID，如果不填写此项则必须上传证书，包括 CertContent（服务端证书内容），CertKey（服务端证书密钥），CertName（服务端证书名称）。", "example": "Fm8Wpag8" }, { "name": "CertCaId", "type": "string", "required": false, "description": "客户端证书的 ID，当监听器采用双向认证，即 SSLMode=MUTUAL 时，如果不填写此项则必须上传客户端证书，包括 CertCaContent，CertCaName。", "example": "HcsGe9BH" }, { "name": "CertName", "type": "string", "required": false, "description": "上传服务端证书的名称，如果没有 CertId，则此项必传。", "example": "NewCert" }, { "name": "CertKey", "type": "string", "required": false, "description": "上传服务端证书的 key，如果没有 CertId，则此项必传。", "example": "-----BEGIN RSA PRIVATE KEY----- certkey -----END RSA PRIVATE KEY-----" }, { "name": "CertContent", "type": "string", "required": false, "description": "上传服务端证书的内容，如果没有 CertId，则此项必传。", "example": "-----BEGIN CERTIFICATE----- certcontent -----END CERTIFICATE" }, { "name": "CertCaName", "type": "string", "required": false, "description": "上传客户端 CA 证书的名称，如果 SSLMode=MUTUAL，如果没有 CertCaId，则此项必传。", "example": "new_certca" }, { "name": "CertCaContent", "type": "string", "required": false, "description": "上传客户端证书的内容，如果 SSLMode=MUTUAL，如果没有 CertCaId，则此项必传。", "example": "-----BEGIN CERTIFICATE----- certcontent -----END CERTIFICATE" } ] }, { "name": "Scheduler", "type": "string", "required": false, "description": "监听器转发的方式。可选值：WRR（按权重轮询）、LEAST_CONN（按最小连接数）、IP_HASH（按 IP 地址哈希）分别表示按权重轮询、最小连接数， 默认为 WRR。使用场景：适用于TCP/UDP/TCP_SSL/QUIC监听器。七层监听器的均衡方式应在转发规则中修改。", "example": "LEAST_CONN" }, { "name": "SniSwitch", "type": "integer", "required": false, "description": "是否开启SNI特性，此参数仅适用于HTTPS监听器。默认0，表示不开启，1表示开启。注意：未开启SNI的监听器可以开启SNI；已开启SNI的监听器不能关闭SNI。", "example": "0" }, { "name": "TargetType", "type": "string", "required": false, "description": "后端目标类型，NODE表示绑定普通节点，TARGETGROUP表示绑定目标组。", "example": "NODE" }, { "name": "KeepaliveEnable", "type": "integer", "required": false, "description": "是否开启长连接，此参数仅适用于HTTP/HTTPS监听器。默认值0表示不开启，1表示开启。若后端服务对连接数上限有限制，则建议谨慎开启。此功能目前处于内测中，如需使用，请提交 内测申请。", "example": "0" }, { "name": "DeregisterTargetRst", "type": "boolean", "required": false, "description": "重新调度功能，解绑后端服务开关，打开此开关，当解绑后端服务时触发重新调度。仅TCP/UDP监听器支持。", "example": "false" }, { "name": "SessionType", "type": "string", "required": false, "description": "会话保持类型。NORMAL表示默认会话保持类型。QUIC_CID表示根据Quic Connection ID做会话保持。QUIC_CID只支持UDP协议。使用场景：适用于TCP/UDP/TCP_SSL/QUIC监听器。默认为 NORMAL。", "example": "NORMAL" }, { "name": "MultiCertInfo", "type": "object", "required": false, "description": "证书信息，支持同时传入不同算法类型的多本服务端证书；此参数仅适用于未开启SNI特性的HTTPS监听器。此参数和Certificate不能同时传入。", "example": "无", "children": [ { "name": "SSLMode", "type": "string", "required": true, "description": "认证类型，UNIDIRECTIONAL：单向认证，MUTUAL：双向认证", "example": "UNIDIRECTIONAL" }, { "name": "CertList", "type": "array", "required": true, "description": "监听器或规则证书列表，单双向认证，多本服务端证书算法类型不能重复;若SSLMode为双向认证，证书列表必须包含一本ca证书。", "example": "见起类型示例", "item_type": "object", "children": [ { "name": "CertId", "type": "string", "required": false, "description": "证书 ID，如果不填写此项则必须上传证书内容，包括CertName, CertContent，若为服务端证书必须包含CertKey。", "example": "zFzZAAIr" }, { "name": "CertName", "type": "string", "required": false, "description": "上传证书的名称，如果没有 CertId，则此项必传。", "example": "tes-cert" }, { "name": "CertContent", "type": "string", "required": false, "description": "上传证书的公钥；如果没有 CertId，则此项必传。", "example": " -----BEGIN CERTIFICATE-----" }, { "name": "CertKey", "type": "string", "required": false, "description": "上传服务端证书的私钥；如果没有 CertId，则此项必传。", "example": "-----BEGIN RSA PRIVATE KEY----- " } ] }, { "name": "SSLVerifyClient", "type": "string", "required": false, "description": "双向认证时，是否开启客户端认证，ON:开启，OPTIONAL:自适应，默认ON", "example": "ON" } ] }, { "name": "MaxConn", "type": "integer", "required": false, "description": "监听器粒度并发连接数上限，当前仅性能容量型实例且仅TCP/UDP/TCP_SSL/QUIC监听器支持。取值范围：1-实例规格并发连接上限，其中-1表示关闭监听器粒度并发连接数限速。基础网络实例不支持该参数。默认为 -1，表示不限速。", "example": "1" }, { "name": "MaxCps", "type": "integer", "required": false, "description": "监听器粒度新建连接数上限，当前仅性能容量型实例且仅TCP/UDP/TCP_SSL/QUIC监听器支持。取值范围：1-实例规格新建连接上限，其中-1表示关闭监听器粒度新建连接数限速。基础网络实例不支持该参数。默认为 -1 表示不限速。", "example": "1" }, { "name": "IdleConnectTimeout", "type": "integer", "required": false, "description": "空闲连接超时时间，此参数仅适用于TCP/UDP监听器。如需设置超过1980s，请通过 工单申请,最大可设置到3600s。取值范围：[10, 1980]单位：秒默认值：900TCP监听器默认值：900，UDP监听器默认值：300s。取值范围：共享型实例和独占型实例支持：10～900，性能容量型实例支持：10~1980。", "example": "900" }, { "name": "ProxyProtocol", "type": "boolean", "required": false, "description": "TCP_SSL和QUIC是否支持PP", "example": "false" }, { "name": "SnatEnable", "type": "boolean", "required": false, "description": "是否开启SNAT（源IP替换），True（开启）、False（关闭）。默认为关闭。注意：SnatEnable开启时会替换客户端源IP，此时透传客户端源IP选项关闭，反之亦然。", "example": "false" }, { "name": "DataCompressMode", "type": "string", "required": false, "description": "数据压缩模式枚举值：transparent： 透明模式（默认值）compatibility： 兼容模式（开启 gzip 兼容压缩配置）", "example": "transparent" }, { "name": "RescheduleTargetZeroWeight", "type": "boolean", "required": false, "description": "重新调度功能，权重调为0开关，打开此开关，后端服务器权重调为0时触发重新调度。仅TCP/UDP监听器支持。", "example": "false" }, { "name": "RescheduleUnhealthy", "type": "boolean", "required": false, "description": "重新调度功能，健康检查异常开关，打开此开关，后端服务器健康检查异常时触发重新调度。仅TCP/UDP监听器支持。", "example": "false" }, { "name": "RescheduleExpandTarget", "type": "boolean", "required": false, "description": "重新调度功能，扩容后端服务开关，打开此开关，后端服务器增加或者减少时触发重新调度。仅TCP/UDP监听器支持。", "example": "false" }, { "name": "RescheduleStartTime", "type": "integer", "required": false, "description": "重新调度触发开始时间，取值0~3600s。仅TCP/UDP监听器支持。", "example": "600" }, { "name": "RescheduleInterval", "type": "integer", "required": false, "description": "重新调度触发持续时间，取值0~3600s。仅TCP/UDP监听器支持。", "example": "600" } ], "required": [ "LoadBalancerId", "ListenerId" ] }, { "name": "ModifyLoadBalancerAttributes", "description": "修改负载均衡实例的属性。支持修改负载均衡实例的名称、设置负载均衡的跨域属性。 注意：非带宽上移用户的 CLB 实例必须加入带宽包才可以设置跨域属性。修改网络计费模式请到控制台操作。 本接口为异步接口，接口返回成功后，需以得到的 RequestID 为入参，调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡的唯一ID，可以通过 DescribeLoadBalancers 接口获取。", "example": "lb-6efswuxa" }, { "name": "LoadBalancerName", "type": "string", "required": false, "description": "负载均衡实例名称，规则：1-80 个英文字母、汉字等国际通用语言字符，数字，连接线“-”、下划线“_”等常见字符（禁止Unicode补充字符，如emoji表情、生僻汉字等）。", "example": "newlbname" }, { "name": "TargetRegionInfo", "type": "object", "required": false, "description": "设置负载均衡跨地域绑定1.0的后端服务信息", "example": "无", "children": [ { "name": "Region", "type": "string", "required": true, "description": "Target所属地域，如 ap-guangzhou", "example": "ap-guangzhou" }, { "name": "VpcId", "type": "string", "required": true, "description": "Target所属网络，私有网络格式如 vpc-abcd1234，如果是基础网络，则为\"0\"", "example": "vpc-6kog****" }, { "name": "NumericalVpcId", "type": "integer", "required": false, "description": "Target所属网络，私有网络格式如86323，如果是基础网络，则为0", "example": "0" } ] }, { "name": "InternetChargeInfo", "type": "object", "required": false, "description": "网络计费相关参数", "example": "无", "children": [ { "name": "InternetChargeType", "type": "string", "required": false, "description": "TRAFFIC_POSTPAID_BY_HOUR 按流量按小时后计费 ; BANDWIDTH_POSTPAID_BY_HOUR 按带宽按小时后计费，国际站用户不支持该计费模式; BANDWIDTH_PACKAGE 按带宽包计费;BANDWIDTH_PREPAID按带宽预付费。", "example": "BANDWIDTH_POSTPAID_BY_HOUR" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "最大出带宽，单位Mbps，仅对公网属性的共享型、性能容量型和独占型 CLB 实例、以及内网属性的性能容量型 CLB 实例生效。 - 对于公网属性的共享型和独占型 CLB 实例，最大出带宽的范围为1Mbps-2048Mbps。 - 对于公网属性和内网属性的性能容量型 CLB实例，最大出带宽的范围为1Mbps-61440Mbps。 （调用CreateLoadBalancer创建LB时不指定此参数则设置为默认值10Mbps。此上限可调整）", "example": "1" }, { "name": "BandwidthpkgSubType", "type": "string", "required": false, "description": "带宽包的类型，如 BGP（多线）。 类型如下： SINGLEISP: 单线 BGP: 多线 HIGH_QUALITY_BGP: 精品BGP共享带宽包 SINGLEISP_CMCC: 中国移动共享带宽包 SINGLEISP_CTCC: 中国电信共享带宽包 SINGLEISP_CUCC: 中国联通共享带宽包 注意：此字段可能返回 null，表示取不到有效值。", "example": "SINGLEISP" } ] }, { "name": "LoadBalancerPassToTarget", "type": "boolean", "required": false, "description": "Target是否放通来自CLB的流量。开启放通（true）：只验证CLB上的安全组；不开启放通（false）：需同时验证CLB和后端实例上的安全组。不填则不修改。", "example": "true" }, { "name": "SwitchFlag", "type": "integer", "required": false, "description": "不同计费模式之间的切换：0表示不切换，1表示预付费和后付费切换，2表示后付费之间切换。默认值：0", "example": "0" }, { "name": "SnatPro", "type": "boolean", "required": false, "description": "是否开启跨地域绑定2.0功能。不填则不修改。", "example": "false" }, { "name": "DeleteProtect", "type": "boolean", "required": false, "description": "是否开启删除保护，不填则不修改。", "example": "false" }, { "name": "ModifyClassicDomain", "type": "boolean", "required": false, "description": "将负载均衡二级域名由mycloud.com改为tencentclb.com，子域名也会变换，修改后mycloud.com域名将失效。不填则不修改。", "example": "true" }, { "name": "AssociateEndpoint", "type": "string", "required": false, "description": "关联的终端节点Id，可通过DescribeVpcEndPoint接口查询。传空字符串代表解除关联。", "example": "vpce-h0fk8lfc" } ], "required": [ "LoadBalancerId" ] }, { "name": "ModifyLoadBalancerMixIpTarget", "description": "修改IPv6FullChain负载均衡7层监听器支持混绑IPv4/IPv6目标特性。", "status": "online", "parameters": [ { "name": "LoadBalancerIds", "type": "array", "required": true, "description": "负载均衡实例ID数组，默认支持20个负载均衡实例ID。 可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459) 接口查询。", "example": "[\"lb-1234abcd\",\"lb-5678wwqq\"]", "item_type": "string" }, { "name": "MixIpTarget", "type": "boolean", "required": true, "description": "开启/关闭IPv6FullChain负载均衡7层监听器支持混绑IPv4/IPv6目标特性。", "example": "true" } ], "required": [ "LoadBalancerIds", "MixIpTarget" ] }, { "name": "ModifyLoadBalancerSla", "description": "本接口（ModifyLoadBalancerSla）用于调整按量计费模式实例的性能容量型规格，如共享型升级性能容量型，性能容量型实例规格调整。 限制条件： - 本接口只支持调整按量计费的CLB实例，包年包月的CLB实例升级请通过控制台进行调整。 - 共享型升级为性能容量型实例后，不支持再回退到共享型实例。 - 传统型负载均衡实例不支持升级为性能容量型实例。", "status": "online", "parameters": [ { "name": "LoadBalancerSla", "type": "array", "required": true, "description": "负载均衡实例信息。", "example": "无", "item_type": "object", "children": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例 ID。 可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459) 接口查询。", "example": "lb-57x2wzka" }, { "name": "SlaType", "type": "string", "required": true, "description": "性能容量型规格，取值范围： 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规格 如需了解规格详情，请参见[实例规格对比](https://cloud.tencent.com/document/product/214/84689)", "example": "clb.c4.xlarge" } ] }, { "name": "Force", "type": "boolean", "required": false, "description": "是否强制升级，默认否。", "example": "false" } ], "required": [ "LoadBalancerSla" ] }, { "name": "ModifyLoadBalancersProject", "description": "修改一个或多个负载均衡实例所属项目。", "status": "online", "parameters": [ { "name": "LoadBalancerIds", "type": "array", "required": true, "description": "一个或多个待操作的负载均衡实例ID，可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459) 接口查询。 列表支持最大长度为20。", "example": "[\"lb-1234abcd\",\"lb-5678wwqq\"]", "item_type": "string" }, { "name": "ProjectId", "type": "integer", "required": true, "description": "项目ID。可以通过 [DescribeProject](https://cloud.tencent.com/document/api/651/78725) 接口获取。", "example": "1122" } ], "required": [ "LoadBalancerIds", "ProjectId" ] }, { "name": "ModifyRule", "description": "ModifyRule 接口用来修改负载均衡七层监听器下的转发规则的各项属性，包括转发路径、健康检查属性、转发策略等。 本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例 ID，可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。", "example": "lb-cuxw2rm0" }, { "name": "ListenerId", "type": "string", "required": true, "description": "负载均衡监听器 ID，可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口获取。", "example": "lbl-4fbxq45k" }, { "name": "LocationId", "type": "string", "required": true, "description": "要修改的转发规则的 ID， 可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口获取。", "example": "loc-9dr7bsl3" }, { "name": "Url", "type": "string", "required": false, "description": "转发规则的新的转发路径，如不需修改Url，则不需提供此参数。", "example": "/bar" }, { "name": "HealthCheck", "type": "object", "required": false, "description": "健康检查信息。", "example": "无", "children": [ { "name": "HealthSwitch", "type": "integer", "required": false, "description": "是否开启健康检查：1（开启）、0（关闭）。 默认为开启。", "example": "0" }, { "name": "TimeOut", "type": "integer", "required": false, "description": "健康检查的响应超时时间，可选值：2~60，默认值：2，单位：秒。响应超时时间要小于检查间隔时间。", "example": "2" }, { "name": "IntervalTime", "type": "integer", "required": false, "description": "健康检查探测间隔时间，默认值：5，IPv4 CLB实例的取值范围为：2-300，IPv6 CLB 实例的取值范围为：5-300。单位：秒。 说明：部分老旧 IPv4 CLB实例的取值范围为：5-300。", "example": "5" }, { "name": "HealthNum", "type": "integer", "required": false, "description": "健康阈值，默认值：3，表示当连续探测三次健康则表示该转发正常，可选值：2~10，单位：次。", "example": "3" }, { "name": "UnHealthNum", "type": "integer", "required": false, "description": "不健康阈值，默认值：3，表示当连续探测三次不健康则表示该转发异常，可选值：2~10，单位：次。", "example": "3" }, { "name": "HttpCode", "type": "integer", "required": false, "description": "健康检查状态码（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式）。可选值：1~31，默认 31。 1 表示探测后返回值 1xx 代表健康，2 表示返回 2xx 代表健康，4 表示返回 3xx 代表健康，8 表示返回 4xx 代表健康，16 表示返回 5xx 代表健康。若希望多种返回码都可代表健康，则将相应的值相加。 注意：此字段可能返回 null，表示取不到有效值。", "example": "8" }, { "name": "HttpCheckPath", "type": "string", "required": false, "description": "健康检查路径（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "/xxx" }, { "name": "HttpCheckDomain", "type": "string", "required": false, "description": "健康检查域名，将在HTTP协议 Host 头字段中携带。（仅适用于HTTP/HTTPS监听器和TCP监听器的HTTP健康检查方式。针对TCP监听器，当使用HTTP健康检查方式时，该参数为必填项）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "www.xxxx.com" }, { "name": "HttpCheckMethod", "type": "string", "required": false, "description": "健康检查方法（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式），默认值：HEAD，可选值HEAD或GET。 注意：此字段可能返回 null，表示取不到有效值。", "example": "HEAD" }, { "name": "CheckPort", "type": "integer", "required": false, "description": "自定义探测相关参数。健康检查端口，默认为后端服务的端口，除非您希望指定特定端口，否则建议留空。传参数值-1可恢复默认设置。（仅适用于TCP/UDP监听器）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "8000" }, { "name": "ContextType", "type": "string", "required": false, "description": "自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查的输入格式，可取值：HEX或TEXT；取值为HEX时，SendContext和RecvContext的字符只能在0123456789ABCDEF中选取且长度必须是偶数位。（仅适用于TCP/UDP监听器） 注意：此字段可能返回 null，表示取不到有效值。", "example": "TEXT" }, { "name": "SendContext", "type": "string", "required": false, "description": "自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查发送的请求内容，只允许ASCII可见字符，最大长度限制500。（仅适用于TCP/UDP监听器）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "request-info" }, { "name": "RecvContext", "type": "string", "required": false, "description": "自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查返回的结果，只允许ASCII可见字符，最大长度限制500。（仅适用于TCP/UDP监听器）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "response-info" }, { "name": "CheckType", "type": "string", "required": false, "description": "健康检查使用的协议。取值 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默认值与后端转发协议一致。", "example": "HTTP" }, { "name": "HttpVersion", "type": "string", "required": false, "description": "HTTP版本。健康检查协议CheckType的值取HTTP时，必传此字段，代表后端服务的HTTP版本：HTTP/1.0、HTTP/1.1；（仅适用于TCP监听器） 注意：此字段可能返回 null，表示取不到有效值。", "example": "HTTP/1.1" }, { "name": "SourceIpType", "type": "integer", "required": false, "description": "健康检查源IP类型：0（使用LB的VIP作为源IP），1（使用100.64网段IP作为源IP）。", "example": "0" }, { "name": "ExtendedCode", "type": "string", "required": false, "description": "GRPC健康检查状态码（仅适用于后端转发协议为GRPC的规则）。默认值为 12，可输入值为数值、多个数值、或者范围，例如 20 或 20,25 或 0-99 注意：此字段可能返回 null，表示取不到有效值。", "example": "12" } ] }, { "name": "Scheduler", "type": "string", "required": false, "description": "规则的请求转发方式，可选值：WRR、LEAST_CONN、IP_HASH 分别表示按权重轮询、最小连接数、按IP哈希， 默认为 WRR。", "example": "LEAST_CONN" }, { "name": "SessionExpireTime", "type": "integer", "required": false, "description": "会话保持时间。取值范围0或30-86400（单位：秒）。 默认为0。", "example": "75" }, { "name": "ForwardType", "type": "string", "required": false, "description": "负载均衡实例与后端服务之间的转发协议，默认HTTP，可取值：HTTP、HTTPS、GRPC。仅HTTPS监听器该参数有效。", "example": "HTTP" }, { "name": "TrpcCallee", "type": "string", "required": false, "description": "TRPC被调服务器路由，ForwardType为TRPC时必填。目前暂未对外开放。", "example": "TestCallee" }, { "name": "TrpcFunc", "type": "string", "required": false, "description": "TRPC调用服务接口，ForwardType为TRPC时必填。目前暂未对外开放。", "example": "TestFunc" }, { "name": "OAuth", "type": "object", "required": false, "description": "OAuth配置信息。", "example": "无", "children": [ { "name": "OAuthEnable", "type": "boolean", "required": false, "description": "开启或关闭鉴权。 True: 开启; False: 关闭 默认为关闭。", "example": "True" }, { "name": "OAuthFailureStatus", "type": "string", "required": false, "description": "IAP全部故障后，拒绝请求还是放行。 BYPASS: 通过 REJECT: 拒绝 默认为 BYPASS", "example": "BYPASS" } ] }, { "name": "CookieName", "type": "string", "required": false, "description": "自定义cookie名", "example": "test_cookie" } ], "required": [ "LoadBalancerId", "ListenerId", "LocationId" ] }, { "name": "ModifyTargetGroupAttribute", "description": "修改目标组的名称或者默认端口属性", "status": "online", "parameters": [ { "name": "TargetGroupId", "type": "string", "required": true, "description": "目标组的ID。", "example": "lbtg-815iz538" }, { "name": "TargetGroupName", "type": "string", "required": false, "description": "目标组的新名称。命名规则：1-80 个英文字母、汉字等国际通用语言字符，数字，连接线“-”、下划线“_”等常见字符（禁止Unicode补充字符，如emoji表情、生僻汉字等）。", "example": "xxxxholic" }, { "name": "Port", "type": "integer", "required": false, "description": "目标组的新默认端口。全监听目标组不支持此参数。", "example": "22" }, { "name": "ScheduleAlgorithm", "type": "string", "required": false, "description": "调度算法，仅V2新版目标组，且后端转发协议为(HTTP|HTTPS|GRPC)时该参数有效。可选值：\u0026lt;ur\u0026gt;WRR:按权重轮询。LEAST_CONN:最小连接数。IP_HASH:按IP哈希。默认为 WRR。\u0026lt;ur\u0026gt;", "example": "LEAST_CONN" }, { "name": "HealthCheck", "type": "object", "required": false, "description": "健康检查详情。", "example": "无", "children": [ { "name": "HealthSwitch", "type": "boolean", "required": true, "description": "是否开启健康检查。", "example": "true" }, { "name": "Protocol", "type": "string", "required": false, "description": "健康检查方式， 其中仅V2新版目标组类型支持该参数， 支持取值 TCP | HTTP | HTTPS | PING | CUSTOM，其中: 当目标组后端转发协议为TCP时， 健康检查方式支持 TCP/HTTP/CUSTOM， 默认为TCP。当目标组后端转发协议为UDP时， 健康检查方式支持 PING/CUSTOM，默认为PING。当目标组后端转发协议为HTTP时， 健康检查方式支持 HTTP/TCP， 默认为HTTP。当目标组后端转发协议为HTTPS时， 健康检查方式支持 HT...", "example": "TCP" }, { "name": "Port", "type": "integer", "required": false, "description": "自定义探测相关参数。健康检查端口，默认为后端服务的端口，除非您希望指定特定端口，否则建议留空。（仅适用于TCP/UDP目标组）。", "example": "80" }, { "name": "Timeout", "type": "integer", "required": false, "description": "健康检查超时时间。 默认为2秒。 可配置范围：2 - 30秒。", "example": "2" }, { "name": "GapTime", "type": "integer", "required": false, "description": "检测间隔时间。 默认为5秒。 可配置范围：2 - 300秒。", "example": "5" }, { "name": "GoodLimit", "type": "integer", "required": false, "description": "检测健康阈值。 默认为3秒。 可配置范围：2 - 10次。", "example": "3" }, { "name": "BadLimit", "type": "integer", "required": false, "description": "检测不健康阈值。 默认为3秒。 可配置范围：2 - 10次。", "example": "3" }, { "name": "JumboFrame", "type": "boolean", "required": false, "description": "目标组下的所有rs的探测包是否开启巨帧。默认开启。仅GWLB类型目标组支持该参数。", "example": "true" }, { "name": "HttpCode", "type": "integer", "required": false, "description": "健康检查状态码（仅适用于HTTP/HTTPS目标组、TCP目标组的HTTP健康检查方式）。可选值：1~31，默认 31，其中： 1 表示探测后返回值 1xx 代表健康。2 表示返回 2xx 代表健康。4 表示返回 3xx 代表健康。8 表示返回 4xx 代表健康。16 表示返回 5xx 代表健康。若希望多种返回码都可代表健康，则将相应的值相加。 注意：此字段可能返回 null，表示取不到有效值。", "example": "504" }, { "name": "HttpCheckDomain", "type": "string", "required": false, "description": "健康检查域名， 其中：仅适用于HTTP/HTTPS目标组和TCP目标组的HTTP健康检查方式。针对HTTP/HTTPS目标组，当使用HTTP健康检查方式时，该参数为必填项。 注意：此字段可能返回 null，表示取不到有效值。", "example": "www.xxxx.com" }, { "name": "HttpCheckPath", "type": "string", "required": false, "description": "健康检查路径（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "/xxx\t/xxx" }, { "name": "HttpCheckMethod", "type": "string", "required": false, "description": "健康检查方法（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式），默认值：HEAD，可选值HEAD或GET。 注意：此字段可能返回 null，表示取不到有效值。", "example": "HEAD" }, { "name": "ContextType", "type": "string", "required": false, "description": "健康检查的输入格式，健康检查方式取CUSTOM时，必填此字段，可取值：HEX或TEXT，其中：TEXT：文本格式。HEX：十六进制格式， SendContext和RecvContext的字符只能在0123456789ABCDEF中选取且长度必须是偶数位。仅适用于TCP/UDP目标组。 注意：此字段可能返回 null，表示取不到有效值。", "example": "TEXT" }, { "name": "SendContext", "type": "string", "required": false, "description": "自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查发送的请求内容，只允许ASCII可见字符，最大长度限制500。（仅适用于TCP/UDP目标组）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ping" }, { "name": "RecvContext", "type": "string", "required": false, "description": "自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查返回的结果，只允许ASCII可见字符，最大长度限制500。（仅适用于TCP/UDP目标组）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "pong" }, { "name": "HttpVersion", "type": "string", "required": false, "description": "HTTP版本, 其中：健康检查协议CheckType的值取HTTP时，必传此字段。支持配置选项：HTTP/1.0, HTTP/1.1。仅适用于TCP目标组。 注意：此字段可能返回 null，表示取不到有效值。", "example": "HTTP/1.1" }, { "name": "ExtendedCode", "type": "string", "required": false, "description": "GRPC健康检查状态码（仅适用于后端转发协议为GRPC的目标组）。默认值为 12，可输入值为数值、多个数值、或者范围，例如 20 或 20,25 或 0-99。 注意：此字段可能返回 null，表示取不到有效值。", "example": "12" } ] }, { "name": "Weight", "type": "integer", "required": false, "description": "后端服务默认权重, 其中：取值范围[0, 100]设置该值后，添加后端服务到目标组时， 若后端服务不单独设置权重， 则使用这里的默认权重。 v1目标组类型不支持设置Weight参数。", "example": "100" }, { "name": "KeepaliveEnable", "type": "boolean", "required": false, "description": "是否开启长连接，此参数仅适用于HTTP/HTTPS目标组，true:关闭；false:开启， 默认关闭。", "example": "true" }, { "name": "SessionExpireTime", "type": "integer", "required": false, "description": "会话保持时间，单位：秒。可选值：30~3600，默认 0，表示不开启。TCP/UDP目标组不支持该参数。", "example": "30" }, { "name": "SnatEnable", "type": "boolean", "required": false, "description": "是否开启SNAT（源IP替换），True（开启）、False（关闭）。默认为关闭。注意：SnatEnable开启时会替换客户端源IP，此时透传客户端源IP选项关闭，反之亦然。", "example": "true" } ], "required": [ "TargetGroupId" ] }, { "name": "ModifyTargetGroupInstancesPort", "description": "批量修改目标组服务器端口。 本接口为异步接口，本接口返回成功后需以返回的 RequestID 为入参，调用 DescribeTaskStatus 接口查询本次任务是否成功。", "status": "online", "parameters": [ { "name": "TargetGroupId", "type": "string", "required": true, "description": "目标组ID。", "example": "lbtg-815iz538" }, { "name": "TargetGroupInstances", "type": "array", "required": true, "description": "待修改端口的服务器数组，在这个接口 NewPort 和 Port 为必填项。", "example": "无", "item_type": "object", "children": [ { "name": "BindIP", "type": "string", "required": true, "description": "目标组实例的内网IP", "example": "x.x.x.x" }, { "name": "Port", "type": "integer", "required": false, "description": "目标组实例的端口，全监听目标组不支持传此字段。", "example": "80" }, { "name": "Weight", "type": "integer", "required": false, "description": "目标组实例的权重 v2目标组需要配置权重，调用CreateTargetGroup接口创建目标组时该参数与创建接口中的Weight参数必填其一。 取值范围：0-100", "example": "10" }, { "name": "NewPort", "type": "integer", "required": false, "description": "目标组实例的新端口，全监听目标组不支持传此字段。", "example": "80" } ] } ], "required": [ "TargetGroupId", "TargetGroupInstances" ] }, { "name": "ModifyTargetGroupInstancesWeight", "description": "批量修改目标组的服务器权重。 本接口为异步接口，本接口返回成功后需以返回的 RequestID 为入参，调用 DescribeTaskStatus 接口查询本次任务是否成功。", "status": "online", "parameters": [ { "name": "TargetGroupId", "type": "string", "required": true, "description": "目标组ID。", "example": "lbtg-815iz538" }, { "name": "TargetGroupInstances", "type": "array", "required": true, "description": "待修改权重的服务器数组，在这个接口 Port 为必填项。", "example": "无", "item_type": "object", "children": [ { "name": "BindIP", "type": "string", "required": true, "description": "目标组实例的内网IP", "example": "x.x.x.x" }, { "name": "Port", "type": "integer", "required": false, "description": "目标组实例的端口，全监听目标组不支持传此字段。", "example": "80" }, { "name": "Weight", "type": "integer", "required": false, "description": "目标组实例的权重 v2目标组需要配置权重，调用CreateTargetGroup接口创建目标组时该参数与创建接口中的Weight参数必填其一。 取值范围：0-100", "example": "10" }, { "name": "NewPort", "type": "integer", "required": false, "description": "目标组实例的新端口，全监听目标组不支持传此字段。", "example": "80" } ] } ], "required": [ "TargetGroupId", "TargetGroupInstances" ] }, { "name": "ModifyTargetPort", "description": "ModifyTargetPort接口用于修改监听器绑定的后端服务的端口。 本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例ID。", "example": "lb-cuxw****" }, { "name": "ListenerId", "type": "string", "required": true, "description": "负载均衡监听器ID。", "example": "lbl-d1ub****" }, { "name": "Targets", "type": "array", "required": true, "description": "要修改端口的后端服务列表。", "example": "无", "item_type": "object", "children": [ { "name": "Port", "type": "integer", "required": true, "description": "后端服务的监听端口。 注意：绑定CVM（云服务器）或ENI（弹性网卡）时必传此参数", "example": "80" }, { "name": "Type", "type": "string", "required": false, "description": "后端服务的类型，可取：CVM（云服务器）、ENI（弹性网卡）；作为入参时，目前本参数暂不生效。", "example": "CVM" }, { "name": "InstanceId", "type": "string", "required": false, "description": "绑定CVM时需要传入此参数，代表CVM的唯一 ID，可通过 DescribeInstances 接口返回字段中的 InstanceId 字段获取。表示绑定主网卡主IPv4地址；以下场景都不支持指定InstanceId：绑定非CVM，绑定CVM上的辅助网卡IP，通过跨域2.0绑定CVM，以及绑定CVM的IPv6地址等。 注意：参数 InstanceId、EniIp 有且只能传入其中一个参数。", "example": "ins-xxxxxxxx" }, { "name": "Weight", "type": "integer", "required": false, "description": "后端服务修改后的转发权重，取值范围：[0, 100]，默认为 10。此参数的优先级高于[RsWeightRule](https://cloud.tencent.com/document/api/214/30694#RsWeightRule)中的Weight参数，即最终的权重值以此Weight参数值为准，仅当此Weight参数为空时，才以RsWeightRule中的Weight参数为准。", "example": "10" }, { "name": "EniIp", "type": "string", "required": false, "description": "绑定IP时需要传入此参数，支持弹性网卡的IP和其他内网IP，如果是弹性网卡则必须先绑定至CVM，然后才能绑定到负载均衡实例。 注意：参数 InstanceId、EniIp 有且只能传入其中一个参数。如果绑定双栈IPV6子机，则必须传该参数。如果是跨地域绑定，则必须传该参数，不支持传InstanceId参数。", "example": "x.x.x.x" }, { "name": "Tag", "type": "string", "required": false, "description": "标签。", "example": "tag_taget" } ] }, { "name": "NewPort", "type": "integer", "required": true, "description": "后端服务绑定到监听器或转发规则的新端口。", "example": "334" }, { "name": "LocationId", "type": "string", "required": false, "description": "转发规则的ID，当后端服务绑定到七层转发规则时，必须提供此参数或Domain+Url两者之一。", "example": "loc-fi8g****" }, { "name": "Domain", "type": "string", "required": false, "description": "目标规则的域名，提供LocationId参数时本参数不生效。", "example": "www.qcloud.example.com" }, { "name": "Url", "type": "string", "required": false, "description": "目标规则的URL，提供LocationId参数时本参数不生效。", "example": "/index" } ], "required": [ "LoadBalancerId", "ListenerId", "Targets", "NewPort" ] }, { "name": "ModifyTargetWeight", "description": "ModifyTargetWeight 接口用于修改负载均衡绑定的后端服务的转发权重。 本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例ID。", "example": "lb-cuxw****" }, { "name": "ListenerId", "type": "string", "required": true, "description": "负载均衡监听器ID。", "example": "lbl-d1ub****" }, { "name": "Targets", "type": "array", "required": true, "description": "要修改权重的后端服务列表。", "example": "无", "item_type": "object", "children": [ { "name": "Port", "type": "integer", "required": true, "description": "后端服务的监听端口。 注意：绑定CVM（云服务器）或ENI（弹性网卡）时必传此参数", "example": "80" }, { "name": "Type", "type": "string", "required": false, "description": "后端服务的类型，可取：CVM（云服务器）、ENI（弹性网卡）；作为入参时，目前本参数暂不生效。", "example": "CVM" }, { "name": "InstanceId", "type": "string", "required": false, "description": "绑定CVM时需要传入此参数，代表CVM的唯一 ID，可通过 DescribeInstances 接口返回字段中的 InstanceId 字段获取。表示绑定主网卡主IPv4地址；以下场景都不支持指定InstanceId：绑定非CVM，绑定CVM上的辅助网卡IP，通过跨域2.0绑定CVM，以及绑定CVM的IPv6地址等。 注意：参数 InstanceId、EniIp 有且只能传入其中一个参数。", "example": "ins-xxxxxxxx" }, { "name": "Weight", "type": "integer", "required": false, "description": "后端服务修改后的转发权重，取值范围：[0, 100]，默认为 10。此参数的优先级高于[RsWeightRule](https://cloud.tencent.com/document/api/214/30694#RsWeightRule)中的Weight参数，即最终的权重值以此Weight参数值为准，仅当此Weight参数为空时，才以RsWeightRule中的Weight参数为准。", "example": "10" }, { "name": "EniIp", "type": "string", "required": false, "description": "绑定IP时需要传入此参数，支持弹性网卡的IP和其他内网IP，如果是弹性网卡则必须先绑定至CVM，然后才能绑定到负载均衡实例。 注意：参数 InstanceId、EniIp 有且只能传入其中一个参数。如果绑定双栈IPV6子机，则必须传该参数。如果是跨地域绑定，则必须传该参数，不支持传InstanceId参数。", "example": "x.x.x.x" }, { "name": "Tag", "type": "string", "required": false, "description": "标签。", "example": "tag_taget" } ] }, { "name": "LocationId", "type": "string", "required": false, "description": "转发规则的ID，当绑定机器到七层转发规则时，必须提供此参数或Domain+Url两者之一。", "example": "loc-fi8g****" }, { "name": "Domain", "type": "string", "required": false, "description": "目标规则的域名，提供LocationId参数时本参数不生效。", "example": "www.new.example.com" }, { "name": "Url", "type": "string", "required": false, "description": "目标规则的URL，提供LocationId参数时本参数不生效。", "example": "/index" }, { "name": "Weight", "type": "integer", "required": false, "description": "后端服务新的转发权重，取值范围：0~100，默认值10。如果设置了 Targets.Weight 参数，则此参数不生效。", "example": "8" } ], "required": [ "LoadBalancerId", "ListenerId", "Targets" ] }, { "name": "RegisterFunctionTargets", "description": "RegisterFunctionTargets 接口用来将一个云函数绑定到负载均衡的7层转发规则，在此之前您需要先行创建相关的7层监听器（HTTP、HTTPS）和转发规则。 本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。 限制说明： - 仅广州、深圳金融、上海、上海金融、北京、成都、中国香港、新加坡、东京、硅谷地域支持绑定 SCF。 - 仅...", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例 ID。", "example": "lb-1234abcd" }, { "name": "ListenerId", "type": "string", "required": true, "description": "负载均衡监听器 ID。", "example": "lbl-1234tgbh" }, { "name": "FunctionTargets", "type": "array", "required": true, "description": "待绑定的云函数列表。", "example": "无", "item_type": "object", "children": [ { "name": "Function", "type": "object", "required": true, "description": "云函数相关信息", "example": "无", "children": [ { "name": "FunctionNamespace", "type": "string", "required": true, "description": "函数命名空间", "example": "default" }, { "name": "FunctionName", "type": "string", "required": true, "description": "函数名称", "example": "bxs-open-api" }, { "name": "FunctionQualifier", "type": "string", "required": true, "description": "函数的版本名称或别名", "example": "$LATEST" }, { "name": "FunctionQualifierType", "type": "string", "required": false, "description": "标识 FunctionQualifier 参数的类型，可取值： VERSION（版本）、ALIAS（别名） 注意：此字段可能返回 null，表示取不到有效值。", "example": "VERSION" } ] }, { "name": "Weight", "type": "integer", "required": false, "description": "权重", "example": "10" } ] }, { "name": "LocationId", "type": "string", "required": false, "description": "目标转发规则的 ID，当将云函数绑定到七层转发规则时，必须输入此参数或 Domain+Url 参数。", "example": "loc-1234rrrr" }, { "name": "Domain", "type": "string", "required": false, "description": "目标转发规则的域名，若已经输入 LocationId 参数，则本参数不生效。", "example": "www.123.com" }, { "name": "Url", "type": "string", "required": false, "description": "目标转发规则的 URL，若已经输入 LocationId 参数，则本参数不生效。", "example": "/test" } ], "required": [ "LoadBalancerId", "ListenerId", "FunctionTargets" ] }, { "name": "RegisterTargetGroupInstances", "description": "注册服务器到目标组。 本接口为异步接口，本接口返回成功后需以返回的 RequestID 为入参，调用 DescribeTaskStatus 接口查询本次任务是否成功。", "status": "online", "parameters": [ { "name": "TargetGroupId", "type": "string", "required": true, "description": "目标组ID", "example": "lbtg-815iz538" }, { "name": "TargetGroupInstances", "type": "array", "required": true, "description": "服务器实例数组，服务器和目标组的 VPC 需相同。", "example": "无", "item_type": "object", "children": [ { "name": "BindIP", "type": "string", "required": true, "description": "目标组实例的内网IP", "example": "x.x.x.x" }, { "name": "Port", "type": "integer", "required": false, "description": "目标组实例的端口，全监听目标组不支持传此字段。", "example": "80" }, { "name": "Weight", "type": "integer", "required": false, "description": "目标组实例的权重 v2目标组需要配置权重，调用CreateTargetGroup接口创建目标组时该参数与创建接口中的Weight参数必填其一。 取值范围：0-100", "example": "10" }, { "name": "NewPort", "type": "integer", "required": false, "description": "目标组实例的新端口，全监听目标组不支持传此字段。", "example": "80" } ] } ], "required": [ "TargetGroupId", "TargetGroupInstances" ] }, { "name": "RegisterTargets", "description": "RegisterTargets 接口用来将一台或多台后端服务绑定到负载均衡的监听器（或7层转发规则），在此之前您需要先行创建相关的4层监听器或7层转发规则。对于四层监听器（TCP、UDP），只需指定监听器ID即可，对于七层监听器（HTTP、HTTPS），还需通过LocationId或者Domain+Url指定转发规则。 本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用 [DescribeTaskStatus](https://cloud.te...", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例ID。", "example": "lb-cuxw****" }, { "name": "ListenerId", "type": "string", "required": true, "description": "负载均衡监听器ID。", "example": "lbl-d1ub****" }, { "name": "Targets", "type": "array", "required": true, "description": "待绑定的后端服务列表，数组长度最大支持20。", "example": "无", "item_type": "object", "children": [ { "name": "Port", "type": "integer", "required": true, "description": "后端服务的监听端口。 注意：绑定CVM（云服务器）或ENI（弹性网卡）时必传此参数", "example": "80" }, { "name": "Type", "type": "string", "required": false, "description": "后端服务的类型，可取：CVM（云服务器）、ENI（弹性网卡）；作为入参时，目前本参数暂不生效。", "example": "CVM" }, { "name": "InstanceId", "type": "string", "required": false, "description": "绑定CVM时需要传入此参数，代表CVM的唯一 ID，可通过 DescribeInstances 接口返回字段中的 InstanceId 字段获取。表示绑定主网卡主IPv4地址；以下场景都不支持指定InstanceId：绑定非CVM，绑定CVM上的辅助网卡IP，通过跨域2.0绑定CVM，以及绑定CVM的IPv6地址等。 注意：参数 InstanceId、EniIp 有且只能传入其中一个参数。", "example": "ins-xxxxxxxx" }, { "name": "Weight", "type": "integer", "required": false, "description": "后端服务修改后的转发权重，取值范围：[0, 100]，默认为 10。此参数的优先级高于[RsWeightRule](https://cloud.tencent.com/document/api/214/30694#RsWeightRule)中的Weight参数，即最终的权重值以此Weight参数值为准，仅当此Weight参数为空时，才以RsWeightRule中的Weight参数为准。", "example": "10" }, { "name": "EniIp", "type": "string", "required": false, "description": "绑定IP时需要传入此参数，支持弹性网卡的IP和其他内网IP，如果是弹性网卡则必须先绑定至CVM，然后才能绑定到负载均衡实例。 注意：参数 InstanceId、EniIp 有且只能传入其中一个参数。如果绑定双栈IPV6子机，则必须传该参数。如果是跨地域绑定，则必须传该参数，不支持传InstanceId参数。", "example": "x.x.x.x" }, { "name": "Tag", "type": "string", "required": false, "description": "标签。", "example": "tag_taget" } ] }, { "name": "LocationId", "type": "string", "required": false, "description": "转发规则的ID，可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口获取，当绑定后端服务到七层转发规则时，必须提供此参数或Domain+Url两者之一。", "example": "loc-fi8g****" }, { "name": "Domain", "type": "string", "required": false, "description": "目标转发规则的域名，提供LocationId参数时本参数不生效。", "example": "www.qcloud.example.com" }, { "name": "Url", "type": "string", "required": false, "description": "目标转发规则的URL，提供LocationId参数时本参数不生效。", "example": "/index" } ], "required": [ "LoadBalancerId", "ListenerId", "Targets" ] }, { "name": "RegisterTargetsWithClassicalLB", "description": "RegisterTargetsWithClassicalLB 接口用于绑定后端服务到传统型负载均衡。本接口为异步接口，接口返回成功后，需以返回的 RequestId 为入参，调用 DescribeTaskStatus 接口查询本次任务是否成功。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例ID。", "example": "lb-a3u5****" }, { "name": "Targets", "type": "array", "required": true, "description": "后端服务信息。", "example": "无", "item_type": "object", "children": [ { "name": "InstanceId", "type": "string", "required": true, "description": "后端实例ID", "example": "ins-em3pxxxx" }, { "name": "Weight", "type": "integer", "required": false, "description": "权重，取值范围 [0, 100]", "example": "10" } ] } ], "required": [ "LoadBalancerId", "Targets" ] }, { "name": "RenewLoadBalancers", "description": "本接口 (RenewLoadBalancers) 用于续费包年包月实例。", "status": "online", "parameters": [ { "name": "LoadBalancerIds", "type": "array", "required": true, "description": "负载均衡实例唯一ID数组，最多支持20个。", "example": "[\"lb-hcrzu8au\"]", "item_type": "string" }, { "name": "LBChargePrepaid", "type": "object", "required": true, "description": "负载均衡实例的预付费相关属性。", "example": "无", "children": [ { "name": "RenewFlag", "type": "string", "required": false, "description": "续费类型：AUTO_RENEW 自动续费， MANUAL_RENEW 手动续费", "example": "AUTO_RENEW" }, { "name": "Period", "type": "integer", "required": false, "description": "购买时长，单位：月", "example": "1" } ] } ], "required": [ "LoadBalancerIds", "LBChargePrepaid" ] }, { "name": "ReplaceCertForLoadBalancers", "description": "ReplaceCertForLoadBalancers 接口用以替换负载均衡实例所关联的证书，对于各个地域的负载均衡，如果指定的老的证书ID与其有关联关系，则会先解除关联，再建立新证书与该负载均衡的关联关系。 此接口支持替换服务端证书或客户端证书。 需要使用的新证书，可以通过传入证书ID来指定，如果不指定证书ID，则必须传入证书内容等相关信息，用以新建证书并绑定至负载均衡。 注：\ufffd...", "status": "online", "parameters": [ { "name": "OldCertificateId", "type": "string", "required": true, "description": "需要被替换的证书的ID，可以是服务端证书或客户端证书", "example": "cuxw0123" }, { "name": "Certificate", "type": "object", "required": true, "description": "新证书的内容等相关信息", "example": "无", "children": [ { "name": "SSLMode", "type": "string", "required": false, "description": "认证类型，UNIDIRECTIONAL：单向认证，MUTUAL：双向认证。 默认为 UNIDIRECTIONAL。", "example": "UNIDIRECTIONAL" }, { "name": "SSLVerifyClient", "type": "string", "required": false, "description": "双向认证时，是否开启客户端认证，ON:开启，OPTIONAL:自适应，默认ON。", "example": "ON" }, { "name": "CertId", "type": "string", "required": false, "description": "服务端证书的 ID，如果不填写此项则必须上传证书，包括 CertContent（服务端证书内容），CertKey（服务端证书密钥），CertName（服务端证书名称）。", "example": "Fm8Wpag8" }, { "name": "CertCaId", "type": "string", "required": false, "description": "客户端证书的 ID，当监听器采用双向认证，即 SSLMode=MUTUAL 时，如果不填写此项则必须上传客户端证书，包括 CertCaContent，CertCaName。", "example": "HcsGe9BH" }, { "name": "CertName", "type": "string", "required": false, "description": "上传服务端证书的名称，如果没有 CertId，则此项必传。", "example": "NewCert" }, { "name": "CertKey", "type": "string", "required": false, "description": "上传服务端证书的 key，如果没有 CertId，则此项必传。", "example": "-----BEGIN RSA PRIVATE KEY----- certkey -----END RSA PRIVATE KEY-----" }, { "name": "CertContent", "type": "string", "required": false, "description": "上传服务端证书的内容，如果没有 CertId，则此项必传。", "example": "-----BEGIN CERTIFICATE----- certcontent -----END CERTIFICATE" }, { "name": "CertCaName", "type": "string", "required": false, "description": "上传客户端 CA 证书的名称，如果 SSLMode=MUTUAL，如果没有 CertCaId，则此项必传。", "example": "new_certca" }, { "name": "CertCaContent", "type": "string", "required": false, "description": "上传客户端证书的内容，如果 SSLMode=MUTUAL，如果没有 CertCaId，则此项必传。", "example": "-----BEGIN CERTIFICATE----- certcontent -----END CERTIFICATE" } ] } ], "required": [ "OldCertificateId", "Certificate" ] }, { "name": "SetCustomizedConfigForLoadBalancer", "description": "负载均衡维度的个性化配置相关操作：创建、删除、修改、绑定、解绑", "status": "online", "parameters": [ { "name": "OperationType", "type": "string", "required": true, "description": "操作类型。 - ADD：创建 - DELETE：删除 - UPDATE：修改 - BIND：绑定 - UNBIND：解绑", "example": "ADD" }, { "name": "UconfigId", "type": "string", "required": false, "description": "个性化配置ID。除了创建个性化配置外，必传此字段，如：pz-1234abcd", "example": "pz-n651fsue" }, { "name": "ConfigContent", "type": "string", "required": false, "description": "个性化配置内容。创建个性化配置或修改个性化配置的内容时，必传此字段。 具体限制查看 [七层个性化配置](https://cloud.tencent.com/document/product/214/15171)", "example": "client_max_body_size 222M;" }, { "name": "ConfigName", "type": "string", "required": false, "description": "个性化配置名称。创建个性化配置或修改个性化配置的名字时，必传此字段。", "example": "config_test" }, { "name": "LoadBalancerIds", "type": "array", "required": false, "description": "负载均衡实例ID。绑定解绑时，必传此字段。 可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459) 接口查询。", "example": "[lb-55rh44i6]", "item_type": "string" } ], "required": [ "OperationType" ] }, { "name": "SetLoadBalancerClsLog", "description": "增加、删除、更新负载均衡的日志服务(CLS)主题。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例 ID，可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459) 接口查询。", "example": "lb-cuxw2r00" }, { "name": "LogSetId", "type": "string", "required": true, "description": "日志服务(CLS)的日志集 ID。 增加和更新日志主题时可调用 [DescribeLogsets](https://cloud.tencent.com/document/product/614/58624) 接口获取日志集 ID。 删除日志主题时，此参数填写为**空字符串**即可。", "example": "ac251c08-778c-4fbc-981b-4898dd48d928" }, { "name": "LogTopicId", "type": "string", "required": true, "description": "日志服务(CLS)的日志主题 ID。 增加和更新日志主题时可调用 [DescribeTopics](https://cloud.tencent.com/document/product/614/56454) 接口获取日志主题 ID。 删除日志主题时，此参数填写为**空字符串**即可。", "example": "f43636fe-06fc-417b-9349-da4bc8a03745" }, { "name": "LogType", "type": "string", "required": false, "description": "日志类型： ACCESS：访问日志 HEALTH：健康检查日志 默认为ACCESS。", "example": "ACCESS" } ], "required": [ "LoadBalancerId", "LogSetId", "LogTopicId" ] }, { "name": "SetLoadBalancerSecurityGroups", "description": "SetLoadBalancerSecurityGroups 接口支持对一个公网负载均衡实例执行设置（绑定、解绑）安全组操作。查询一个负载均衡实例目前已绑定的安全组，可使用 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459) 接口。本接口是set语义， 绑定操作时，入参需要传入负载均衡实例要绑定的所有安全组（已绑定的+新增绑定的）。 解绑操作时，入参需要传入负载均衡实例执行解绑后所...", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例 ID，可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459) 接口查询。", "example": "lb-cuxw2r00" }, { "name": "SecurityGroups", "type": "array", "required": false, "description": "安全组ID构成的数组，一个负载均衡实例最多可绑定50个安全组，如果要解绑所有安全组，可不传此参数。 可以通过 [DescribeSecurityGroups](https://cloud.tencent.com/document/product/215/15808) 接口查询。", "example": "[\"sg-0936o7sd\",\"sg-12345678\"]", "item_type": "string" } ], "required": [ "LoadBalancerId" ] }, { "name": "SetLoadBalancerStartStatus", "description": "启停负载均衡实例或者监听器。 本接口为异步接口，接口返回成功后，需以得到的 RequestID 为入参，调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。 该功能正在内测中，如需使用，请通过[工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=6\u0026level2_id=163\u0026source=0\u0026data_title=%E8%B4%9F%E8%BD%BD%E5%9D%87%E8%A1%A1%20LB\u0026step=1)。", "status": "online", "parameters": [ { "name": "OperationType", "type": "string", "required": true, "description": "操作类型。Start：启动实例，Stop：停止实例。", "example": "Stop" }, { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例ID，可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459) 接口查询。", "example": "lb-hwdt33e0" }, { "name": "ListenerIds", "type": "array", "required": false, "description": "监听器ID。如果该字段为空，则表示操作负载均衡实例，如果不为空，则表示操作监听器。", "example": "[\"lbl-amze00hu\"]", "item_type": "string" } ], "required": [ "OperationType", "LoadBalancerId" ] }, { "name": "SetSecurityGroupForLoadbalancers", "description": "绑定或解绑一个安全组到多个公网负载均衡实例。", "status": "online", "parameters": [ { "name": "SecurityGroup", "type": "string", "required": true, "description": "安全组ID，如 sg-12345678。可以通过 [DescribeSecurityGroups](https://cloud.tencent.com/document/product/215/15808) 接口获取。", "example": "sg-12345678" }, { "name": "OperationType", "type": "string", "required": true, "description": "ADD 绑定安全组； DEL 解绑安全组", "example": "ADD" }, { "name": "LoadBalancerIds", "type": "array", "required": true, "description": "负载均衡实例ID数组，可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459) 接口查询。 列表支持的最大长度为20。", "example": "[\"lb-0936o712\",\"lb-tttt5555\"]", "item_type": "string" } ], "required": [ "SecurityGroup", "OperationType", "LoadBalancerIds" ] } ] }