边缘安全加速平台 EO 创建负载均衡实例-负载均衡相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： teo.tencentcloudapi.com 。

创建负载均衡实例。详情请参考快速创建负载均衡实例。负载均衡功能内测中，如您需要使用请联系我们。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateLoadBalancer。
Version	是	String	公共参数，本接口取值：2022-09-01。
Region	否	String	公共参数，此参数为可选参数。
ZoneId	是	String	站点 ID。
Name	是	String	实例名称，可输入 1-200 个字符，允许字符为 a-z，A-Z，0-9，_，-。
Type	是	String	实例类型，取值有： HTTP：HTTP 专用型，支持添加 HTTP 专用型和通用型源站组，仅支持被站点加速相关服务引用（如域名服务和规则引擎）； GENERAL：通用型，仅支持添加通用型源站组，能被站点加速服务（如域名服务和规则引擎）和四层代理引用。
OriginGroups.N	是	Array of OriginGroupInLoadBalancer	源站组列表及其对应的容灾调度优先级。详情请参考快速创建负载均衡实例中的示例场景。
HealthChecker	否	HealthChecker	健康检查策略。详情请参考健康检查策略介绍。不填写时，默认为不启用健康检查。
SteeringPolicy	否	String	源站组间的流量调度策略，取值有： Pritory：按优先级顺序进行故障转移。默认值为 Pritory。
FailoverPolicy	否	String	实际访问某源站失败时的请求重试策略，详情请参考请求重试策略介绍，取值有： OtherOriginGroup：单次请求失败后，请求优先重试下一优先级源站组； OtherRecordInOriginGroup：单次请求失败后，请求优先重试同源站组内的其他源站。默认值为 OtherRecordInOriginGroup。

3. 输出参数

参数名称	类型	描述
InstanceId	String	负载均衡实例 ID。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建健康检查策略为 ICMP Ping 的负载均衡实例

健康检查策略选择 ICMP Ping，请求重试策略选择重试组内其他源站。

输入示例

POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateLoadBalancer
<公共请求参数>

{
    "ZoneId": "zone-2ju9lrnpaxol",
    "Name": "ICMP-LB",
    "Type": "HTTP",
    "OriginGroups": [
        {
            "Priority": "priority_1",
            "OriginGroupId": "og-30l5kv5z2bse"
        },
        {
            "Priority": "priority_2",
            "OriginGroupId": "og-30l5kv5z2bse"
        }
    ],
    "HealthChecker": {
        "Type": "ICMP Ping",
        "Interval": 30,
        "Timeout": 5,
        "HealthThreshold": 3,
        "CriticalThreshold": 2
    },
    "SteeringPolicy": "Pritory",
    "FailoverPolicy": "OtherRecordInOriginGroup"
}

输出示例

{
    "Response": {
        "RequestId": "c2967195-cfd7-4bd0-ac05-d2eaccde6909",
        "InstanceId": "lb-2osw7z07dnyu"
    }
}

示例2 创建健康检查策略为 HTTPS 的负载均衡实例

健康检查策略选择 HTTPS，请求重试策略选择重试组内其他源站。

输入示例

POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateLoadBalancer
<公共请求参数>

{
    "ZoneId": "zone-2ju9lrnpaxol",
    "Name": "HTTPS-LB",
    "Type": "GENERAL",
    "OriginGroups": [
        {
            "Priority": "priority_1",
            "OriginGroupId": "og-30l5kv5z2bse"
        },
        {
            "Priority": "priority_2",
            "OriginGroupId": "og-30l5kv5z2bse"
        },
        {
            "Priority": "priority_3",
            "OriginGroupId": "og-30l5kv5z2bse"
        }
    ],
    "HealthChecker": {
        "Type": "HTTPS",
        "Path": "www.example.com/test",
        "Port": 80,
        "Interval": 30,
        "Method": "HEAD",
        "ExpectedCodes": [
            "200",
            "500",
            "501",
            "502",
            "503",
            "504",
            "505",
            "507",
            "520",
            "521",
            "525",
            "530",
            "544",
            "562",
            "567",
            "599"
        ],
        "FollowRedirect": "true",
        "Headers": [
            {
                "Key": "header1",
                "Value": "header1"
            },
            {
                "Key": "header2",
                "Value": "header2"
            },
            {
                "Key": "header3",
                "Value": "header3"
            }
        ],
        "Timeout": 5,
        "HealthThreshold": 3,
        "CriticalThreshold": 2
    },
    "SteeringPolicy": "Pritory",
    "FailoverPolicy": "OtherRecordInOriginGroup"
}

输出示例

{
    "Response": {
        "RequestId": "c2967195-cfd7-4bd0-ac05-d2eaccde6909",
        "InstanceId": "lb-2osw7z17dnyu"
    }
}

示例3 创建健康检查策略为 HTTP 的负载均衡实例

健康检查策略选择 HTTP，请求重试策略选择重试组内其他源站。

输入示例

POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateLoadBalancer
<公共请求参数>

{
    "ZoneId": "zone-2ju9lrnpaxol",
    "Name": "HTTP-LB",
    "Type": "GENERAL",
    "OriginGroups": [
        {
            "Priority": "priority_1",
            "OriginGroupId": "og-30l5kv5z2bse"
        },
        {
            "Priority": "priority_2",
            "OriginGroupId": "og-30l5kv5z2bse"
        },
        {
            "Priority": "priority_3",
            "OriginGroupId": "og-30l5kv5z2bse"
        }
    ],
    "HealthChecker": {
        "Type": "HTTP",
        "Path": "www.example.com/test",
        "Port": 80,
        "Interval": 30,
        "Method": "HEAD",
        "ExpectedCodes": [
            "200",
            "500",
            "501",
            "502",
            "503",
            "504",
            "505",
            "507",
            "520",
            "521",
            "525",
            "530",
            "544",
            "562",
            "567",
            "599"
        ],
        "FollowRedirect": "true",
        "Headers": [
            {
                "Key": "header1",
                "Value": "header1"
            },
            {
                "Key": "header2",
                "Value": "header2"
            },
            {
                "Key": "header3",
                "Value": "header3"
            }
        ],
        "Timeout": 5,
        "HealthThreshold": 3,
        "CriticalThreshold": 2
    },
    "SteeringPolicy": "Pritory",
    "FailoverPolicy": "OtherRecordInOriginGroup"
}

输出示例

{
    "Response": {
        "RequestId": "c2967195-cfd7-4bd0-ac05-d2eaccde6909",
        "InstanceId": "lb-2osw7z07dnyu"
    }
}

示例4 创建健康检查策略为 TCP 的负载均衡实例

健康检查策略选择 TCP，请求重试策略选择重试下一优先级源站组。

输入示例

POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateLoadBalancer
<公共请求参数>

{
    "ZoneId": "zone-2ju9lrnsaxol",
    "Name": "TCP-LB",
    "Type": "HTTP",
    "OriginGroups": [
        {
            "Priority": "priority_1",
            "OriginGroupId": "og-30l5kv5z2bse"
        },
        {
            "Priority": "priority_2",
            "OriginGroupId": "og-30l5kv5z2bse"
        }
    ],
    "HealthChecker": {
        "Type": "TCP",
        "Port": 80,
        "Interval": 30,
        "Timeout": 5,
        "HealthThreshold": 3,
        "CriticalThreshold": 2
    },
    "SteeringPolicy": "Pritory",
    "FailoverPolicy": "OtherOriginGroup"
}

输出示例

{
    "Response": {
        "RequestId": "afe08af5-51f3-4f2e-911b-987ebb88a572",
        "InstanceId": "lb-2osbdyhu19iy"
    }
}

示例5 创建健康检查策略为 UDP 的负载均衡实例

健康检查策略选择 UDP，请求重试策略选择重试下一优先级源站组。

输入示例

POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateLoadBalancer
<公共请求参数>

{
    "ZoneId": "zone-2ju9lsnpaxol",
    "Name": "UDP-LB",
    "Type": "GENERAL",
    "OriginGroups": [
        {
            "Priority": "priority_1",
            "OriginGroupId": "og-30l5kv5z215e"
        },
        {
            "Priority": "priority_2",
            "OriginGroupId": "og-30l5kv5z2bse"
        }
    ],
    "HealthChecker": {
        "Type": "UDP",
        "Port": 80,
        "SendContext": "requestcontent",
        "RecvContext": "responsecontent",
        "Interval": 30,
        "Timeout": 5,
        "HealthThreshold": 3,
        "CriticalThreshold": 2
    },
    "SteeringPolicy": "Pritory",
    "FailoverPolicy": "OtherOriginGroup"
}

输出示例

{
    "Response": {
        "RequestId": "57d0154c-f9ab-42b7-ad83-232106647ff3",
        "InstanceId": "lb-2oswhs520uqe"
    }
}

示例6 创建不启用探测的负载均衡实例

不启用任何健康检查策略，请求重试策略选择重试下一优先级源站组。适用于仅配置主备源站的场景。

输入示例

POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateLoadBalancer
<公共请求参数>

{
    "ZoneId": "zone-2ju9lrnpaxol",
    "Name": "NoCheck-LB",
    "Type": "HTTP",
    "OriginGroups": [
        {
            "Priority": "priority_1",
            "OriginGroupId": "og-30l5kv5z2bse"
        },
        {
            "Priority": "priority_2",
            "OriginGroupId": "og-30l5kv5z2ase"
        }
    ],
    "HealthChecker": {
        "Type": "NoCheck"
    },
    "SteeringPolicy": "Pritory",
    "FailoverPolicy": "OtherOriginGroup"
}

输出示例

{
    "Response": {
        "RequestId": "2c619f7f-27e9-43c5-b42c-68dcca803d35",
        "InstanceId": "lb-2osw2ssziowm"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InvalidParameter.LoadBalancerNameRepeated	同一站点下的负载均衡名称不可以重复。
InvalidParameter.OriginGroupTypeCanNotMatchLBType	源站组类型与负载均衡器类型不匹配。
InvalidParameter.SomeOriginGroupNotExist	一些绑定的源站组不存在。
LimitExceeded.LoadBalancingCountLimitExceeded	负载均衡数量超过限制。

创建负载均衡实例

本页目录：

1. 接口描述

2. 输入参数

3. 输出参数

4. 示例

示例1 创建健康检查策略为 ICMP Ping 的负载均衡实例

输入示例

输出示例

示例2 创建健康检查策略为 HTTPS 的负载均衡实例

输入示例

输出示例

示例3 创建健康检查策略为 HTTP 的负载均衡实例

输入示例

输出示例

示例4 创建健康检查策略为 TCP 的负载均衡实例

输入示例

输出示例

示例5 创建健康检查策略为 UDP 的负载均衡实例

输入示例

输出示例

示例6 创建不启用探测的负载均衡实例

输入示例

输出示例

5. 开发者资源

腾讯云 API 平台

API Inspector

SDK

命令行工具

6. 错误码