调用 CreateNetworkLoadBalancer 接口，创建一个网络型负载均衡实例。 ## 使用说明通过控制台创建的NLB实例状态变化为：Creating \> Active，通过API创建的NLB实例状态变化为：Provisioning \> Creating \> Active。 ## 请求参数下表中，ZoneMappings.N.a 类型参数中的“N”表示可用区及其对应子网、IP地址或公网IP的序号，取值范围为1～n，n取决于地域的可用区数量，详情可参见[地域与可用区](https://www.volcengine.com/docs/6406/1264536)。多个资源之间使用&分隔。 |名称 |类型 |是否必选 |示例值 |描述 | |---|---|---|---|---| |Action |String |是 |CreateNetworkLoadBalancer |要执行的操作，取值为CreateNetworkLoadBalancer。 | |Version |String |是 |2020\-04\-01 |API版本信息，当前版本为2020\-04\-01。 | |RegionId |String |是 |cn\-guangzhou |请求的地域。 | |NetworkType |String |是 |intranet |NLB实例的网络类型。取值如下：|\ | | | | ||\ | | | | |* internet：公网类型。|\ | | | | |* intranet：私网类型。|\ | | | | ||\ | | | | |:::tip|\ | | | | ||\ | | | | |* 参数`IpAddressVersion`为“dualstack”时，该参数不支持传入“internet”。|\ | | | | |* 参数`IpAddressVersion`为“ipv4”时，该参数传入“internet”，则创建NLB实例时同步关联公网IP。|\ | | | | ||\ | | | | |:::| |LoadBalancerName |String |否 |nlb\-test |NLB实例的名称。|\ | | | | ||\ | | | | |* 必须以字母、数字或中文开头，可包含以下特殊字符：点（.）、下划线（_）和中划线（\-）。|\ | | | | |* 长度限制为1 ～ 128个字符。|\ | | | | |* 该参数不传入，则默认为实例ID。 | |Description |String |否 |This is an NLB. |NLB实例的描述。|\ | | | | ||\ | | | | |* 必须以字母、数字或中文开头，可包含以下特殊字符：英文逗号（,）、点（.）、下划线（_）、空格（）、等号（=）、中划线（\-）、中文逗号（，）、中文句号（。）。|\ | | | | |* 长度限制为0 ～ 255个字符。|\ | | | | |* 该参数不传入，则默认为空字符串。 | |IpAddressVersion |String |否 |ipv4 |NLB实例的IP地址类型。取值如下：|\ | | | | ||\ | | | | |* ipv4（默认值）：表示该网络型负载均衡为IPv4类型，仅支持转发IPv4请求。|\ | | | | |* dualstack：表示该网络型负载均衡为双栈类型，支持转发IPv4和IPv6请求。|\ | | | | ||\ | | | | |:::tip|\ | | | | |网络型负载均衡IPv6功能正在邀测中，如需使用，请联系客户经理。|\ | | | | ||\ | | | | |:::| |Ipv4BandwidthPackageId |String |否 |bwp\-wedfvcrt56hnm\*\*\*\* |IPv4类型的共享带宽包 ID。|\ | | | | |:::tip|\ | | | | |当参数`NetworkType` 传入intranet时，不可传入本参数。|\ | | | | ||\ | | | | |:::| |VpcId |String |是 |vpc\-bp1aevy8sofi8mh1\*\*\*\* |NLB实例所属的VPC ID。您可以调用[DescribeVpcs](https://www.volcengine.com/docs/6401/70495)接口获取VPC ID。 | |CrossZoneEnabled |Boolean |否 |true |NLB实例是否开启跨可用区转发能力。|\ | | | | |请严格按照以下枚举值的大小写输入，不要传入其他取值。|\ | | | | ||\ | | | | |* true（默认值）：开启。|\ | | | | |* false：关闭。 | |ZoneMappings.N.ZoneId |String |是 |ZoneMappings.1.ZoneId=cn\-guangzhou\-a&ZoneMappings.2.ZoneId=cn\-guangzhou\-b |NLB实例支持的可用区的ID。您可以调用[DescribeNLBZones](https://www.volcengine.com/docs/6406/1275760)接口获取可用区ID。|\ | | | | |请至少指定2个可用区。 | |ZoneMappings.N.SubnetId |String |是 |ZoneMappings.1.SubnetId=subnet\-bp12mw1f8k3jgy\*\*\*\*&ZoneMappings.2.SubnetId=subnet\-b2p1mfw18jgk3y\*\*\*\* |NLB实例支持的可用区内的子网ID。您可以调用[DescribeSubnets](https://www.volcengine.com/docs/6401/70497)接口获取子网ID。|\ | | | | |与可用区对应，每个可用区内指定一个子网。 | |ZoneMappings.N.Ipv4Address |String |否 |192.XX.XX.6 |NLB实例的私网IPv4 VIP地址。|\ | | | | |该参数不传入，则系统自动从子网中分配一个可用的IPv4地址。 | |ZoneMappings.N.EipId |String |否 |ZoneMappings.1.EipId=eip\-3ciyamhu46c6rrswwusg\*\*\*\*&ZoneMappings.2.EipId=eip\-huiya25r4ccdrrhywer7\*\*\*\* |公网NLB实例关联的公网IP的ID。|\ | | | | ||\ | | | | |* 参数`IpAddressVersion`为“ipv4”且参数`NetworkType` 为“internet”时，|\ | | | | | * 传入该参数表示使用已有公网IP。|\ | | | | | * 不传入该参数或该参数不传入数值表示新购公网IP。|\ | | | | |* 参数`IpAddressVersion`为“dualstack”或参数`NetworkType` 为“intranet”时，不允许传入该参数。 | |SecurityGroupIds.N |String |是 |SecurityGroupIds.1=sg\-bp67acfmxazb4p\*\*\*\*&SecurityGroupIds.2=sg\-fds32jvnfjnf0f9\*\*\*\* |NLB实例关联的安全组的ID。|\ | | | | ||\ | | | | |* N：表示安全组的序号，取值范围为 1～4。|\ | | | | |* 多个安全组 ID 间使用&分隔。 | |ModificationProtectionStatus |String |否 |ConsoleProtection |NLB实例是否开启控制台修改保护。取值如下：|\ | | | | ||\ | | | | |* NonProtection（默认值）：关闭，允许通过控制台修改或删除实例。|\ | | | | |* ConsoleProtection：开启，禁止通过控制台修改或删除实例。 | |ProjectName |String |否 |default |NLB实例所属项目的名称。|\ | | | | |该参数不传入，则默认为default。 | |Tags.N.Key |String |否 |Tags.1.Key=k1&Tags.2.Key=k2 |用户标签的标签键。|\ | | | | |N：表示标签信息的序号，需按照数字顺序从1开始填写，取值范围 1～20。多个标签键之间使用&分隔。|\ | | | | ||\ | | | | |* 长度限制为1～128个字符。|\ | | | | |* 大小写敏感，不能以`volc:`或`sys:`的任意大小写组合开头。|\ | | | | |* 不能以空格开头或结尾。|\ | | | | |* 允许包含字母、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（\-）和@。|\ | | | | ||\ | | | | |:::tip|\ | | | | |同一资源的标签键不允许重复。|\ | | | | ||\ | | | | |:::| |Tags.N.Value |String |否 |Tags.1.Value=v1&Tags.2.Value=v2 |用户标签的标签值。|\ | | | | |N：表示标签信息的序号，需按照数字顺序从1开始填写，取值范围 1～20。多个标签值之间使用&分隔。每个标签键对应一个标签值。|\ | | | | ||\ | | | | |* 长度限制为0～255个字符。|\ | | | | |* 大小写敏感，不能以空格开头或结尾。|\ | | | | |* 允许包含字母、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（\-）和@。|\ | | | | ||\ | | | | |:::tip|\ | | | | |如果传入该参数，则必须先传入`Tags.N.Key`。|\ | | | | ||\ | | | | |:::| |ClientToken |String |否 |123e4567\-e89b\-12d3\-a456\-42665544\*\*\*\* |客户端Token，用于保证请求的幂等性。|\ | | | | ||\ | | | | |* 该参数值由客户端自动生成，确保不同请求的取值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。|\ | | | | |* 取值仅支持ASCII字符，最大不超过64个字符。|\ | | | | |* 未指定该参数值时，不进行幂等校验。 | ## 返回参数 |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| |RequestId |String |2024092952539010225146063030\*\*\*\* |请求ID。 | |LoadBalancerId |String |nlb\-bp1o94dp5i6ea\*\*\*\* |NLB实例的ID。 | ## 请求示例 ```Plain Text GET /?Action=CreateNetworkLoadBalancer&Version=2020-04-01&RegionId=cn-guangzhou&NetworkType=intranet&LoadBalancerName=nlb-test&VpcId=vpc-bp1aevy8sofi8mh1****&ZoneMappings.1.ZoneId=cn-guangzhou-a&ZoneMappings.2.ZoneId=cn-guangzhou-b&ZoneMappings.1.SubnetId=subnet-bp12mw1f8k3jgy****&ZoneMappings.2.SubnetId=subnet-b2p1mfw18jgk3y****&SecurityGroupIds.1=sg-bp67acfmxazb4p****&SecurityGroupIds.2=sg-fds32jvnfjnf0f9**** HTTP/1.1 Host: open.volcengineapi.com Region: cn-guangzhou Service: clb ``` ## 返回示例 ```Plain Text { "ResponseMetadata": { "RequestId": "2024092952539010225146063030****", "Action": "CreateNetworkLoadBalancer", "Version": "2020-04-01", "Service": "clb", "Region": "cn-guangzhou" }, "Result": { "RequestId": "2024092952539010225146063030****", "LoadBalancerId": "nlb-bp1o94dp5i6ea****" } } ``` ## 错误码您可访问[公共错误码](https://www.volcengine.com/docs/6369/68677)，获取更多错误码信息。