调用 CreateNetworkLoadBalancer 接口,创建一个网络型负载均衡实例。
通过控制台创建的NLB实例状态变化为:Creating > Active,通过API创建的NLB实例状态变化为:Provisioning > Creating > Active。
下表中,ZoneMappings.N.a 类型参数中的“N”表示可用区及其对应子网、IP地址或公网IP的序号,取值范围为1~n,n取决于地域的可用区数量,详情可参见地域与可用区。多个资源之间使用&分隔。
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateNetworkLoadBalancer | 要执行的操作,取值为CreateNetworkLoadBalancer。 |
Version | String | 是 | 2020-04-01 | API版本信息,当前版本为2020-04-01。 |
RegionId | String | 是 | cn-guangzhou | 请求的地域。 |
NetworkType | String | 是 | intranet | NLB实例的网络类型。取值如下:
说明
|
LoadBalancerName | String | 否 | nlb-test | NLB实例的名称。
|
Description | String | 否 | This is an NLB. | NLB实例的描述。
|
IpAddressVersion | String | 否 | ipv4 | NLB实例的IP地址类型。取值如下:
说明 网络型负载均衡IPv6功能正在邀测中,如需使用,请联系客户经理。 |
Ipv4BandwidthPackageId | String | 否 | bwp-wedfvcrt56hnm**** | IPv4 类型的共享带宽包 ID。 说明 若参数 |
VpcId | String | 是 | vpc-bp1aevy8sofi8mh1**** | NLB实例所属的VPC ID。您可以调用DescribeVpcs接口获取VPC ID。 |
CrossZoneEnabled | Boolean | 否 | true | NLB实例是否开启跨可用区转发能力。
|
ZoneMappings.N.ZoneId | String | 是 | ZoneMappings.1.ZoneId=cn-guangzhou-a&ZoneMappings.2.ZoneId=cn-guangzhou-b | NLB实例支持的可用区的ID。您可以调用DescribeNLBZones接口获取可用区ID。 |
ZoneMappings.N.SubnetId | String | 是 | ZoneMappings.1.SubnetId=subnet-bp12mw1f8k3jgy****&ZoneMappings.2.SubnetId=subnet-b2p1mfw18jgk3y**** | NLB实例支持的可用区内的子网ID。您可以调用DescribeSubnets接口获取子网ID。 |
ZoneMappings.N.Ipv4Address | String | 否 | 192.XX.XX.6 | NLB实例的私网IPv4 VIP地址。 |
ZoneMappings.N.EipId | String | 否 | ZoneMappings.1.EipId=eip-3ciyamhu46c6rrswwusg****&ZoneMappings.2.EipId=eip-huiya25r4ccdrrhywer7**** | 公网NLB实例关联的公网IP的ID。
|
SecurityGroupIds.N | String | 是 | SecurityGroupIds.1=sg-bp67acfmxazb4p****&SecurityGroupIds.2=sg-fds32jvnfjnf0f9**** | NLB实例关联的安全组的ID。
|
ModificationProtectionStatus | String | 否 | ConsoleProtection | NLB实例是否开启控制台修改保护。取值如下:
|
ProjectName | String | 否 | default | NLB实例所属项目的名称。 |
Tags.N.Key | String | 否 | Tags.1.Key=k1&Tags.2.Key=k2 | 用户标签的标签键。
说明 同一资源的标签键不允许重复。 |
Tags.N.Value | String | 否 | Tags.1.Value=v1&Tags.2.Value=v2 | 用户标签的标签值。
说明 如果传入该参数,则必须先传入 |
ClientToken | String | 否 | 123e4567-e89b-12d3-a456-42665544**** | 客户端Token,用于保证请求的幂等性。
|
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 2024092952539010225146063030**** | 请求ID。 |
LoadBalancerId | String | nlb-bp1o94dp5i6ea**** | NLB实例的ID。 |
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
{ "ResponseMetadata": { "RequestId": "2024092952539010225146063030****", "Action": "CreateNetworkLoadBalancer", "Version": "2020-04-01", "Service": "clb", "Region": "cn-guangzhou" }, "Result": { "RequestId": "2024092952539010225146063030****", "LoadBalancerId": "nlb-bp1o94dp5i6ea****" } }
您可访问公共错误码,获取更多错误码信息。