{
  "name": "gwlb",
  "display_name": "网关负载均衡",
  "description": "介绍如何使用API的方式使用网关负载均衡服务，包含实例的创建、配置和查询等内容。",
  "domain": "other",
  "api_version": "2024-09-06",
  "endpoint": "gwlb.tencentcloudapi.com",
  "actions": [
    {
      "name": "AssociateTargetGroups",
      "description": "本接口(AssociateTargetGroups)用来将目标组绑定到负载均衡。 本接口为异步接口，本接口返回成功后需以返回的 RequestID 为入参，调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。",
      "status": "online",
      "parameters": [
        {
          "name": "Associations",
          "type": "array",
          "required": true,
          "description": "绑定的关系数组。一次请求最多支持20个。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "LoadBalancerId",
              "type": "string",
              "required": true,
              "description": "网关负载均衡实例ID，可以通过[DescribeGatewayLoadBalancers](https://cloud.tencent.com/document/product/1782/111683)获取网关负载均衡ID。",
              "example": "gwlb-20dhh498"
            },
            {
              "name": "TargetGroupId",
              "type": "string",
              "required": true,
              "description": "目标组ID，可以通过[DescribeTargetGroups](https://cloud.tencent.com/document/product/214/40554)获取目标组ID。",
              "example": "lbtg-0nzo3czo"
            }
          ]
        }
      ],
      "required": [
        "Associations"
      ]
    },
    {
      "name": "CreateGatewayLoadBalancer",
      "description": "本接口(CreateGatewayLoadBalancer)用来创建网关负载均衡实例。为了使用网关负载均衡服务，您必须购买一个或多个网关负载均衡实例。成功调用该接口后，会返回网关负载均衡实例的唯一 ID。 注意：单个账号在每个地域的默认购买配额为：10个。 本接口为异步接口，接口成功返回后，可使用 [DescribeTaskStatus](https://cloud.tencent.com/document/api/1782/111700) 接口查询负载均衡实例的状态。",
      "status": "online",
      "parameters": [
        {
          "name": "VpcId",
          "type": "string",
          "required": true,
          "description": "网关负载均衡后端目标设备所属的私有网络 ID，如vpc-azd4dt1c，可以通过 DescribeVpcs 接口获取。",
          "example": "vpc-30xq****"
        },
        {
          "name": "SubnetId",
          "type": "string",
          "required": true,
          "description": "网关负载均衡后端目标设备所属的私有网络的子网ID。可通过DescribeSubnets接口获取。",
          "example": "subnet-xxx"
        },
        {
          "name": "LoadBalancerName",
          "type": "string",
          "required": false,
          "description": "网关负载均衡实例名称。命名规则：1-80 个英文字母、汉字等国际通用语言字符，数字，连接线“-”、下划线“_”等常见字符（禁止Unicode补充字符，如emoji表情、生僻汉字等）。不填写时默认自动生成。",
          "example": "gwlb-xxx"
        },
        {
          "name": "Number",
          "type": "integer",
          "required": false,
          "description": "创建网关负载均衡的个数，默认值为 1。批量创建数量最大支持10个。",
          "example": "1"
        },
        {
          "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": "LBChargeType",
          "type": "string",
          "required": false,
          "description": "网关负载均衡实例计费类型，当前只支持传POSTPAID_BY_HOUR（按量计费），默认是POSTPAID_BY_HOUR。",
          "example": "POSTPAID_BY_HOUR"
        }
      ],
      "required": [
        "VpcId",
        "SubnetId"
      ]
    },
    {
      "name": "CreateTargetGroup",
      "description": "创建目标组。",
      "status": "online",
      "parameters": [
        {
          "name": "TargetGroupName",
          "type": "string",
          "required": false,
          "description": "目标组名称。命名规则：1-80 个英文字母、汉字等国际通用语言字符，数字，连接线“-”、下划线“_”等常见字符（禁止Unicode补充字符，如emoji表情、生僻汉字等）。",
          "example": "test-name"
        },
        {
          "name": "VpcId",
          "type": "string",
          "required": false,
          "description": "网关负载均衡后端目标组所属的网络 ID，如vpc-12345678，可以通过 DescribeVpcs 接口获取。 不填此参数则默认为DefaultVPC。",
          "example": "vpc-i1******"
        },
        {
          "name": "Port",
          "type": "integer",
          "required": false,
          "description": "目标组的默认端口， 后续添加服务器时可使用该默认端口。Port和TargetGroupInstances.N中的port二者必填其一。仅支持6081。",
          "example": "6081"
        },
        {
          "name": "TargetGroupInstances",
          "type": "array",
          "required": false,
          "description": "目标组绑定的后端服务器",
          "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": "目标组实例的端口，只支持6081。",
              "example": "6081"
            },
            {
              "name": "Weight",
              "type": "integer",
              "required": false,
              "description": "目标组实例的权重，只支持0或16，非0统一按16处理。",
              "example": "0"
            }
          ]
        },
        {
          "name": "Protocol",
          "type": "string",
          "required": false,
          "description": "网关负载均衡目标组协议。TENCENT_GENEVE ：GENEVE 标准协议AWS_GENEVE：GENEVE 兼容协议",
          "example": "TENCENT_GENEVE"
        },
        {
          "name": "HealthCheck",
          "type": "object",
          "required": false,
          "description": "健康检查设置。",
          "example": "无",
          "children": [
            {
              "name": "HealthSwitch",
              "type": "boolean",
              "required": false,
              "description": "是否开启健康检查。",
              "example": "true"
            },
            {
              "name": "Protocol",
              "type": "string",
              "required": false,
              "description": "健康检查使用的协议。支持PING和TCP两种方式，默认为PING。 - icmp: 使用PING的方式进行健康检查 - tcp: 使用TCP连接的方式进行健康检查",
              "example": "icmp"
            },
            {
              "name": "Port",
              "type": "integer",
              "required": false,
              "description": "健康检查端口，探测协议为tcp时，该参数必填。",
              "example": "80"
            },
            {
              "name": "Timeout",
              "type": "integer",
              "required": false,
              "description": "健康检查超时时间。 默认为2秒。 可配置范围：2 - 30秒。",
              "example": "2"
            },
            {
              "name": "IntervalTime",
              "type": "integer",
              "required": false,
              "description": "检测间隔时间。 默认为5秒。 可配置范围：2 - 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": "ScheduleAlgorithm",
          "type": "string",
          "required": false,
          "description": "均衡算法。IP_HASH_2_CONSISTENT：二元组一致性哈希IP_HASH_3_CONSISTENT：三元组一致性哈希IP_HASH_5_CONSISTENT：五元组一致性哈希",
          "example": "IP_HASH_5_CONSISTENT"
        },
        {
          "name": "AllDeadToAlive",
          "type": "boolean",
          "required": false,
          "description": "是否支持全死全活。默认支持。",
          "example": "true"
        },
        {
          "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": "ForwardingMode",
          "type": "string",
          "required": false,
          "description": "流量分发方式STATELESS：无状态STATEFUL： 有状态",
          "example": "STATEFUL"
        },
        {
          "name": "RescheduleUnbindRs",
          "type": "boolean",
          "required": false,
          "description": "重新调度功能内的解绑后端服务开关，开关打开后解绑后端服务会触发重新调度。",
          "example": "true"
        },
        {
          "name": "RescheduleUnbindRsStartTime",
          "type": "integer",
          "required": false,
          "description": "解绑RS后开启重调度的时间，可配置0s-3600s，默认0s",
          "example": "200"
        },
        {
          "name": "RescheduleUnhealthy",
          "type": "boolean",
          "required": false,
          "description": "重新调度功能内的后端服务健康探测异常开关，开关打开后后端服务健康检查异常会触发重新调度。",
          "example": "true"
        },
        {
          "name": "RescheduleUnhealthyStartTime",
          "type": "integer",
          "required": false,
          "description": "后端服务健康探测异常后开启重调度的时间，可配置0s-3600s，默认0s",
          "example": "100"
        }
      ],
      "required": []
    },
    {
      "name": "DeleteGatewayLoadBalancer",
      "description": "DeleteGatewayLoadBalancer 接口用以删除指定的一个或多个网关负载均衡实例。成功删除后，会把网关负载均衡实例与后端服务解绑。 本接口为异步接口，接口返回成功后，需以返回的 RequestId 为入参，调用 [DescribeTaskStatus](https://cloud.tencent.com/document/api/1782/111700) 接口查询本次任务是否成功。",
      "status": "online",
      "parameters": [
        {
          "name": "LoadBalancerIds",
          "type": "array",
          "required": true,
          "description": "要删除的网关负载均衡实例 ID数组，数组大小最大支持20。可通过[DescribeGatewayLoadBalancers](https://cloud.tencent.com/document/api/1782/111683) 接口获取。",
          "example": "[\"gwlb-hs******\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "LoadBalancerIds"
      ]
    },
    {
      "name": "DeleteTargetGroups",
      "description": "删除目标组",
      "status": "online",
      "parameters": [
        {
          "name": "TargetGroupIds",
          "type": "array",
          "required": true,
          "description": "目标组ID列表。 可以通过接口[DescribeTargetGroups](https://cloud.tencent.com/document/product/214/40554)获取。",
          "example": "[\"lbtg-f1phe5j6\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "TargetGroupIds"
      ]
    },
    {
      "name": "DeregisterTargetGroupInstances",
      "description": "从目标组中解绑服务器。",
      "status": "online",
      "parameters": [
        {
          "name": "TargetGroupId",
          "type": "string",
          "required": true,
          "description": "目标组ID。可通过[DescribeTargetGroupList](https://cloud.tencent.com/document/api/1782/111692)接口获取。",
          "example": "lbtg-815iz538"
        },
        {
          "name": "TargetGroupInstances",
          "type": "array",
          "required": true,
          "description": "待解绑的服务器信息。",
          "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": "目标组实例的端口，只支持6081。",
              "example": "6081"
            },
            {
              "name": "Weight",
              "type": "integer",
              "required": false,
              "description": "目标组实例的权重，只支持0或16，非0统一按16处理。",
              "example": "0"
            }
          ]
        }
      ],
      "required": [
        "TargetGroupId",
        "TargetGroupInstances"
      ]
    },
    {
      "name": "DescribeGatewayLoadBalancers",
      "description": "查询一个地域的网关负载均衡实例列表。",
      "status": "online",
      "parameters": [
        {
          "name": "LoadBalancerIds",
          "type": "array",
          "required": false,
          "description": "网关负载均衡实例ID。支持批量筛选的实例ID数量上限为20个。",
          "example": "[\"gwlb-pnzsdc1a\"]",
          "item_type": "string"
        },
        {
          "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": "查询负载均衡详细信息列表的过滤条件，每次请求的Filters的上限为10，Filter.Values的上限为100。Filter.Name和Filter.Values皆为必填项。详细的过滤条件如下：- VpcId - String - 是否必填：否 - （过滤条件）按照网关负载均衡实例所属的私有网络过滤，如“vpc-bhqk****”。- Vips - String - 是否必填：否 - （过滤条件）按照网关负载均衡实例的VIP进行过滤，如“10.1.1.1”- tag:tag-key - String - 是否必...",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "过滤器的名称",
              "example": "Vips"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "过滤器的值数组",
              "example": "[\"1.0.0.1\"]",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "SearchKey",
          "type": "string",
          "required": false,
          "description": "搜索字段，模糊匹配名称、VIP。",
          "example": "test-name"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeGatewayLoadBalancersResources",
      "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"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeTargetGroupInstanceStatus",
      "description": "查询目标组后端服务状态。目前仅支持网关负载均衡类型的目标组支持查询后端服务状态。",
      "status": "online",
      "parameters": [
        {
          "name": "TargetGroupId",
          "type": "string",
          "required": true,
          "description": "目标组唯一id。可通过[DescribeTargetGroupList](https://cloud.tencent.com/document/api/1782/111692)接口获取。",
          "example": "lbtg-815iz538"
        },
        {
          "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过滤。 - TargetGroupId - String - 是否必填：否 - （过滤条件）目标组ID，如“lbtg-5xunivs0”。可通过[DescribeTargetGroupList](https://cloud.tencent.com/document/api/1782/111692)接口获取。 - BindIP - String - 是否必填：否 - （过滤条件）目标组绑定实例的内网IP地址，如“10.1.1.1”。 - InstanceId - String - 是否必填：否 - （过滤条件）目标组绑定实例的名称，\ufffd...",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "过滤器的名称",
              "example": "Vips"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "过滤器的值数组",
              "example": "[\"1.0.0.1\"]",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "显示数量限制，默认20，最大100。",
          "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 - String - 是否必填：否 - （过滤条件）按照目标组所属的私有网络过滤，可以通过[DescribeVpcs](https://cloud.tencent.com/document/product/215/15778)获取，如“vpc-bhqk****”。 - TargetGroupName - String - 是否必填：否 - （过滤条件）按照目标组的名称过滤，如“tg_name”",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "过滤器的名称",
              "example": "Vips"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "过滤器的值数组",
              "example": "[\"1.0.0.1\"]",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "显示的偏移起始量，默认为0。",
          "example": "1"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "显示条数限制，默认为20，最大值为1000。",
          "example": "20"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeTargetGroups",
      "description": "查询目标组信息",
      "status": "online",
      "parameters": [
        {
          "name": "TargetGroupIds",
          "type": "array",
          "required": false,
          "description": "目标组ID。",
          "example": "[\"lbtg-5xunivs0\\r\\n\"]",
          "item_type": "string"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "显示条数限制，默认为20，最大值为1000。",
          "example": "20"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "显示的偏移起始量，默认为0。",
          "example": "1"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "过滤条件数组。 - TargetGroupVpcId - String - 是否必填：否 - （过滤条件）按照目标组所属的私有网络过滤，可以通过[DescribeVpcs](https://cloud.tencent.com/document/product/215/15778)获取，如“vpc-bhqk****”。 - TargetGroupName - String - 是否必填：否 - （过滤条件）按照目标组的名称过滤，如“tg_name”",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "过滤器的名称",
              "example": "Vips"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "过滤器的值数组",
              "example": "[\"1.0.0.1\"]",
              "item_type": "string"
            }
          ]
        }
      ],
      "required": []
    },
    {
      "name": "DescribeTaskStatus",
      "description": "本接口用于查询异步任务的执行状态，对于非查询类的接口（创建/删除负载均衡实例等），在接口调用成功后，都需要使用本接口查询任务最终是否执行成功。",
      "status": "online",
      "parameters": [
        {
          "name": "TaskId",
          "type": "string",
          "required": false,
          "description": "请求ID，即接口返回的 RequestId 参数。",
          "example": "55c85074-3e7f-4c6d-864f-673660d4f8de"
        }
      ],
      "required": []
    },
    {
      "name": "DisassociateTargetGroups",
      "description": "解除负载均衡和目标组的关联关系。 本接口为异步接口，本接口返回成功后需以返回的 RequestID 为入参，调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。",
      "status": "online",
      "parameters": [
        {
          "name": "Associations",
          "type": "array",
          "required": true,
          "description": "待解绑的目标组列表。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "LoadBalancerId",
              "type": "string",
              "required": true,
              "description": "网关负载均衡实例ID，可以通过[DescribeGatewayLoadBalancers](https://cloud.tencent.com/document/product/1782/111683)获取网关负载均衡ID。",
              "example": "gwlb-20dhh498"
            },
            {
              "name": "TargetGroupId",
              "type": "string",
              "required": true,
              "description": "目标组ID，可以通过[DescribeTargetGroups](https://cloud.tencent.com/document/product/214/40554)获取目标组ID。",
              "example": "lbtg-0nzo3czo"
            }
          ]
        }
      ],
      "required": [
        "Associations"
      ]
    },
    {
      "name": "InquirePriceCreateGatewayLoadBalancer",
      "description": "InquirePriceCreateGatewayLoadBalancer接口查询创建网关负载均衡的价格。",
      "status": "online",
      "parameters": [
        {
          "name": "GoodsNum",
          "type": "integer",
          "required": false,
          "description": "询价的网关负载均衡实例个数，默认为1",
          "example": "1"
        }
      ],
      "required": []
    },
    {
      "name": "ModifyGatewayLoadBalancerAttribute",
      "description": "ModifyGatewayLoadBalancerAttribute 接口用于修改负载均衡实例的属性。支持修改负载均衡实例的名称、带宽上限。",
      "status": "online",
      "parameters": [
        {
          "name": "LoadBalancerId",
          "type": "string",
          "required": true,
          "description": "网关负载均衡的唯一ID。可通过DescribeGatewayLoadBalancers 接口获取。",
          "example": "gwlb-xxx"
        },
        {
          "name": "LoadBalancerName",
          "type": "string",
          "required": false,
          "description": "网关负载均衡实例名称。命名规则：1-80 个英文字母、汉字等国际通用语言字符，数字，连接线“-”、下划线“_”等常见字符（禁止Unicode补充字符，如emoji表情、生僻汉字等）。",
          "example": "newname"
        },
        {
          "name": "DeleteProtect",
          "type": "boolean",
          "required": false,
          "description": "是否开启删除保护。",
          "example": "true"
        }
      ],
      "required": [
        "LoadBalancerId"
      ]
    },
    {
      "name": "ModifyTargetGroupAttribute",
      "description": "修改目标组的名称、健康探测等属性。",
      "status": "online",
      "parameters": [
        {
          "name": "TargetGroupId",
          "type": "string",
          "required": true,
          "description": "目标组的ID，可以通过DescribeTargetGroups获取。",
          "example": "lbtg-815iz538"
        },
        {
          "name": "TargetGroupName",
          "type": "string",
          "required": false,
          "description": "目标组的新名称。命名规则：1-80 个英文字母、汉字等国际通用语言字符，数字，连接线“-”、下划线“_”等常见字符（禁止Unicode补充字符，如emoji表情、生僻汉字等）。",
          "example": "xxxxholic"
        },
        {
          "name": "HealthCheck",
          "type": "object",
          "required": false,
          "description": "健康检查详情。",
          "example": "无",
          "children": [
            {
              "name": "HealthSwitch",
              "type": "boolean",
              "required": false,
              "description": "是否开启健康检查。",
              "example": "true"
            },
            {
              "name": "Protocol",
              "type": "string",
              "required": false,
              "description": "健康检查使用的协议。支持PING和TCP两种方式，默认为PING。 - icmp: 使用PING的方式进行健康检查 - tcp: 使用TCP连接的方式进行健康检查",
              "example": "icmp"
            },
            {
              "name": "Port",
              "type": "integer",
              "required": false,
              "description": "健康检查端口，探测协议为tcp时，该参数必填。",
              "example": "80"
            },
            {
              "name": "Timeout",
              "type": "integer",
              "required": false,
              "description": "健康检查超时时间。 默认为2秒。 可配置范围：2 - 30秒。",
              "example": "2"
            },
            {
              "name": "IntervalTime",
              "type": "integer",
              "required": false,
              "description": "检测间隔时间。 默认为5秒。 可配置范围：2 - 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": "AllDeadToAlive",
          "type": "boolean",
          "required": false,
          "description": "是否支持全死全活。",
          "example": "true"
        },
        {
          "name": "RescheduleUnbindRs",
          "type": "boolean",
          "required": false,
          "description": "重新调度功能内的解绑后端服务开关，开关打开后解绑后端服务会触发重新调度。",
          "example": "true"
        },
        {
          "name": "RescheduleUnbindRsStartTime",
          "type": "integer",
          "required": false,
          "description": "解绑RS后开启重调度的时间，可配置0s-3600s，默认0s",
          "example": "100"
        },
        {
          "name": "RescheduleUnhealthy",
          "type": "boolean",
          "required": false,
          "description": "重新调度功能内的后端服务健康探测异常开关，开关打开后后端服务健康检查异常会触发重新调度。",
          "example": "true"
        },
        {
          "name": "RescheduleUnhealthyStartTime",
          "type": "integer",
          "required": false,
          "description": "后端服务健康探测异常后开启重调度的时间，可配置0s-3600s，默认0s",
          "example": "100"
        }
      ],
      "required": [
        "TargetGroupId"
      ]
    },
    {
      "name": "ModifyTargetGroupInstancesWeight",
      "description": "修改目标组的服务器权重。",
      "status": "online",
      "parameters": [
        {
          "name": "TargetGroupId",
          "type": "string",
          "required": true,
          "description": "目标组ID。可通过[DescribeTargetGroupList](https://cloud.tencent.com/document/api/1782/111692)接口获取。",
          "example": "lbtg-815iz538"
        },
        {
          "name": "TargetGroupInstances",
          "type": "array",
          "required": true,
          "description": "实例绑定配置数组。",
          "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": "目标组实例的端口，只支持6081。",
              "example": "6081"
            },
            {
              "name": "Weight",
              "type": "integer",
              "required": false,
              "description": "目标组实例的权重，只支持0或16，非0统一按16处理。",
              "example": "0"
            }
          ]
        }
      ],
      "required": [
        "TargetGroupId",
        "TargetGroupInstances"
      ]
    },
    {
      "name": "RegisterTargetGroupInstances",
      "description": "注册服务器到目标组。",
      "status": "online",
      "parameters": [
        {
          "name": "TargetGroupId",
          "type": "string",
          "required": true,
          "description": "目标组ID。可通过[DescribeTargetGroupList](https://cloud.tencent.com/document/api/1782/111692)接口获取。",
          "example": "lbtg-815iz538"
        },
        {
          "name": "TargetGroupInstances",
          "type": "array",
          "required": true,
          "description": "服务器实例数组",
          "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": "目标组实例的端口，只支持6081。",
              "example": "6081"
            },
            {
              "name": "Weight",
              "type": "integer",
              "required": false,
              "description": "目标组实例的权重，只支持0或16，非0统一按16处理。",
              "example": "0"
            }
          ]
        }
      ],
      "required": [
        "TargetGroupId",
        "TargetGroupInstances"
      ]
    }
  ]
}