AddNLBBackendServers--负载均衡-火山引擎

文档中心

导航

AddNLBBackendServers

最近更新时间：2024.12.04 17:10:14首次发布时间：2024.12.04 17:10:14

调用 AddNLBBackendServers 接口，为指定服务器组添加后端服务器。

请求参数

下表中，Servers.N.a类型参数中的“N”表示后端服务器的序号，取值范围为1 ～ 20。多个后端服务器之间使用&分隔。

名称	类型	是否必选	示例值	说明
Action	String	是	AddNLBBackendServers	要执行的操作，取值为AddNLBBackendServers。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
ServerGroupId	String	是	rsp-bp1o94dp5i6ea****	服务器组ID。您可以调用DescribeNLBServerGroups接口获取服务器组ID。
Servers.N.Type	String	是	Servers.1.Type=ecs&Servers.2.Type=eni	后端服务器的类型。 ecs：云服务器实例。 eni：网卡。 ip：IP地址。说明服务器组为“instance”类型且待添加的后端服务器为云服务器实例的主网卡时，服务器类型设置为“ecs”。待添加的后端服务器为云服务器绑定的辅助网卡时，服务器类型设置为“eni”。服务器组为“ip”类型时，服务器类型设置为“ip”。
Servers.N.InstanceId	String	是	Servers.1.InstanceId=i-3tkuehz8oa3vj0wz**&Servers.2.InstanceId=eni-2feo5qd3orri85oxruvxv**	服务器实例的ID或IP地址。服务器类型为“ecs”时，传入云服务器实例的ID。您可以调用DescribeInstances接口云服务器实例ID。服务器类型为“eni”时，传入已绑定云服务器实例的网卡ID。您可以调用DescribeNetworkInterfaces接口获取网卡ID。服务器类型为“ip”时，传入后端服务器的IP地址。
Servers.N.ZoneId	String	否	Servers.1.ZoneId=cn-guangzhou-a&Servers.2.ZoneId=cn-guangzhou-b	后端服务器接收来自哪些可用区的访问流量。指定多个可用区时，无论NLB是否开启跨可用区转发，该后端服务器均可以接收来自所有指定可用区的访问流量。
Servers.N.Weight	Integer	否	Servers.1.Weight=100&Servers.2.Weight=100	后端服务器的权重，取值范围为0 ～ 100。权重为0，表示不会将请求转发给该服务器。该参数不传入，则默认为0。
Servers.N.Ip	String	是	Servers.1.Ip=192.XX.XX.2&Servers.2.Ip=192.XX.XX.3	后端服务器的私网IP地址。您可以调用DescribeInstances接口获取“ecs”类型后端服务器的私网IP地址。您可以调用DescribeNetworkInterfaces接口获取“eni”类型后端服务器的私网IP地址。
Servers.N.Port	Integer	否	Servers.1.Port=88&Servers.2.Port=443	后端服务器接收请求的端口号，取值范围为 1～65535。参数`AnyPortEnabled`为“false”，即服务器组未开启全端口转发时，该参数为必填。参数`AnyPortEnabled`为“true”，即服务器组开启全端口转发时，该参数默认为0。
Servers.N.Description	String	否	Servers.1.Description=ecs1&Servers.2.Description=eni1	后端服务器的描述，默认值为空字符串。必须以字母、数字或中文开头，可包含以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）长度限制为0 ～ 255个字符。该参数不传入，则默认为空字符串。

返回参数

名称	类型	示例值	描述
RequestId	String	2024092952539010225146063030****	请求ID。
ServerIds	Array of String	["rs-3cig8e5o0kxs06c6rrsqn**", "rs-3cig8e7n1ozr46c6rrsfn**"]	服务器组中所有后端服务器的ID。

请求示例

GET /?Action=AddNLBBackendServers&Version=2020-04-01&ServerGroupId=rsp-bp1o94dp5i6ea****&Servers.1.Description=test&Servers.1.InstanceId=i-3tkuehz8oa3vj0wz****&Servers.1.Ip=172.XX.XX.242&Servers.1.Port=1&Servers.1.Type=ecs&Servers.1.Weight=100 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-guangzhou
Service: clb

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202409291106382514606306AF947C****",
        "Action": "AddNLBBackendServers",
        "Version": "2020-04-01",
        "Service": "clb",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "RequestId": "20240929110622514606306AF947C****",
        "ServerIds": [
        "rs-3cig8e5o0kxs06c6rrsqn****",
        "rs-3cig8e7n1ozr46c6rrsfn****"
        ]
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。