全部产品
Search

搜索本产品

    负载均衡：CreateLoadBalancer - 创建网络型负载均衡实例

    文档中心

    负载均衡：CreateLoadBalancer - 创建网络型负载均衡实例

    更新时间：Sep 06, 2024

    创建网络型负载均衡实例。

    接口说明

    • 创建网络型负载均衡实例时会自动为用户创建 AliyunServiceRoleForNlb SLR 角色。
    • CreateLoadBalancer 接口属于异步接口，即系统返回一个实例 ID，但该网络型负载均衡实例尚未创建成功，系统后台的创建任务仍在进行。您可以调用 GetLoadBalancerAttribute 查询网络型负载均衡实例的创建状态：
      • 当网络型负载均衡实例处于 Provisioning 状态时，表示网络型负载均衡实例正在创建中。
      • 当网络型负载均衡实例处于 Active 状态时，表示网络型负载均衡实例创建成功。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    nlb:CreateLoadBalancercreate
    • LoadBalancer
      acs:nlb:{#regionId}:{#accountId}:loadbalancer/*
    • VSwitch
      acs:vpc:{#regionId}:{#accountId}:vswitch/{#VSwitchId}
    • EipAddress
      acs:vpc:{#regionId}:{#accountId}:eip/{#AllocationId}
    • VPC
      acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}
      无
    		无

    请求参数

    名称类型必填描述示例值
    LoadBalancerTypestring否

    负载均衡的类型，仅取值：network，表示网络型负载均衡。

    		network
    LoadBalancerNamestring否

    网络型负载均衡实例名称。

    长度为 2~128 个英文或中文字符，必须以大小写英文字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。

    		NLB1
    AddressTypestring是

    网络型负载均衡实例的 IPv4 地址类型。取值：

    • Internet：负载均衡具有公网 IP 地址，DNS 域名被解析到公网 IP，因此可以在公网环境访问。
    • Intranet：负载均衡只有私网 IP 地址，DNS 域名被解析到私网 IP，因此只能被负载均衡所在 VPC 的内网环境访问。
    说明 网络型负载均衡双栈实例的 IPv6 公网需通过 EnableLoadBalancerIpv6Internet 接口开启。
    		Internet
    AddressIpVersionstring否

    协议版本。取值：

    • ipv4（默认值）：IPv4 类型。
    • DualStack：双栈类型。
    		ipv4
    VpcIdstring是

    网络型负载均衡实例的专有网络 ID。

    		vpc-bp1b49rqrybk45nio****
    ZoneMappingsarray<object>是

    可用区及交换机映射列表。最多支持添加 10 个可用区。若当前地域支持 2 个及以上的可用区，至少需要添加 2 个可用区。

    object是

    可用区及交换机映射列表。最多支持添加 10 个可用区。若当前地域支持 2 个及以上的可用区，至少需要添加 2 个可用区。

    VSwitchIdstring是

    可用区对应的交换机，每个可用区只能使用一台交换机和一个子网。最多支持添加 10 个可用区。 若当前地域支持 2 个及以上的可用区，至少需要添加 2 个可用区。

    		vsw-sersdf****
    ZoneIdstring是

    网络型负载均衡实例的可用区 ID。最多支持添加 10 个可用区。若当前地域支持 2 个及以上可用区，至少需要添加 2 个可用区。

    您可以通过调用 DescribeZones 接口获取可用区 ID。

    		cn-hangzhou-a
    PrivateIPv4Addressstring否

    IPv4 私网 VIP 地址。NLB 对外提供服务的私网 IPv4 地址。

    		192.168.10.1
    AllocationIdstring否

    公网实例绑定的 EIP 实例 ID，每个可用区对应 1 个 EIP 实例 ID。最多支持添加 10 个可用区。若当前地域支持 2 个及以上可用区，至少需要添加 2 个可用区。

    		eip-bp1aedxso6u80u0qf****
    Ipv6Addressstring否

    IPv6 VIP 地址。NLB 对外提供服务的 IPv6 地址。

    		2408:400a:d5:3080:b409:840a:ca:e8e5
    Ipv4LocalAddressesarray否

    IPv4 Local 地址列表。NLB 与后端服务交互的地址列表。 地址个数必须是偶数，且最少 2 个，最多 8 个。

    string否

    IPv4 Local 地址。

    		192.168.10.2
    Ipv6LocalAddressesarray否

    IPv6 Local 地址列表。NLB 与后端服务交互的地址列表。 地址个数必须是偶数，且最少 2 个，最多 8 个。

    string否

    IPv6 Local 地址。

    		2408:400a:d5:3080:b409:840a:ca:e8e6
    BandwidthPackageIdstring否

    公网类型实例关联的共享带宽包 ID。

    		cbwp-bp1vevu8h3ieh****
    LoadBalancerBillingConfigobject否

    网络型负载均衡实例计费配置。

    PayTypestring否

    网络型负载均衡实例的计费类型。

    仅取值 PostPay：表示按量计费。

    		PostPay
    ResourceGroupIdstring否

    资源组 ID。

    		rg-atstuj3rtop****
    DryRunboolean否

    是否只预检此次请求。取值：

    • true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。
    • false（默认值）：发送正常请求，通过检查后返回 HTTP 2xx 状态码并直接进行操作。
    		false
    ClientTokenstring否

    客户端 Token，用于保证请求的幂等性。

    从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

    说明 若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
    		123e4567-e89b-12d3-a456-426655440000
    RegionIdstring否

    网络型负载均衡实例所在的地域 ID。

    您可以通过调用 DescribeRegions 接口获取地域 ID。

    		cn-hangzhou
    DeletionProtectionConfigobject否

    删除保护配置。

    Enabledboolean否

    删除保护状态，取值：

    • true：开启状态。
    • false（默认值）：关闭状态。
    		false
    Reasonstring否

    更改删除保护状态的原因。长度为 2~128 个英文或中文字符，必须以大小写英文字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。

    		实例运行中
    ModificationProtectionConfigobject否

    修改保护配置。

    Statusstring否

    网络型负载均衡修改保护状态。取值：

    • NonProtection：不保护，表示不允许传入保护配置的 Reason。如果配置了保护配置的 Reason，则清空其配置信息。
    • ConsoleProtection：控制台修改保护，此时允许传入保护配置的 Reason。
    说明 当取值为 ConsoleProtection，即开启修改保护后，用户不能通过负载均衡控制台修改实例配置，但可以通过调用 API 修改实例配置。
    		ConsoleProtection
    Reasonstring否

    输入开启修改保护的原因。长度为 2~128 个英文或中文字符，必须以大小写英文字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。

    说明 仅在 Status 为 ConsoleProtection 时有效且合法。
    		业务保障期
    Tagarray<object>否

    标签列表。

    object否

    标签。

    Keystring否

    标签键。最多支持 64 个字符，不能以aliyun或acs:开头，不能包含http://或https://。支持字符包括字母、数字、下划线 (_)、点 (.)、冒号 (:)、斜线 (/)、等号 (=)、加号 (+)、减号 (-)、@符号 (@) 。

    一次调用最多支持添加 20 个标签。

    		env
    Valuestring否

    标签值。最多支持 128 个字符，不能以aliyun或acs:开头，不能包含http://或https://。支持字符包括字母、数字、下划线 (_)、点 (.)、冒号 (:)、斜线 (/)、等号 (=)、加号 (+)、减号 (-)、@符号 (@) 。

    一次调用最多支持添加 20 个标签。

    		product

    返回参数

    名称类型描述示例值
    object

    response

    RequestIdstring

    请求 ID。

    		CEF72CEB-54B6-4AE8-B225-F876FF7BA984
    LoadbalancerIdstring

    实例 ID。

    		nlb-83ckzc8d4xlp8o****
    OrderIdlong

    网络型负载均衡实例的订单 ID。

    		20230000

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "LoadbalancerId": "nlb-83ckzc8d4xlp8o****",
  "OrderId": 20230000
}

    错误码

    HTTP status code错误码错误信息描述
    400OperationDenied.OnlyPayByTrafficSupportedThe operation is not allowed because of OnlyPayByTrafficSupported.由于仅支持按流量计费，因此不允许进行此操作。
    400OperationFailed.%sThe operation failed because of %s.因为%操作当前API失败
    400Mismatch.ZoneIdAndVswitchIdThe ZoneIdAndVswitchId is mismatched for %s and %s.ZoneId和VswitchId缺失，请检查输入参数。
    400QuotaExceeded.%sThe quota of %s is exceeded, usage %s/%s.%s的配额超过限制，已使用%s/%s
    400DryRunOperationRequest validation has been passed with DryRun flag set.dryRun请求验证已通过。
    400OperationDenied.OnlyPostPaidSupportedThe operation is not allowed because of OnlyPostPaidSupported.由于仅支持后付费，因此不允许进行此操作。
    400OperationFailed.DuplicateZones.The operation failed because of Can not Specify duplicate zones.由于指定了重复的可用区，操作失败。请修改参数。
    400ResourceNotEnough.VSwitchIpThe specified resource of VSwitchIp is not enough.所指定的虚拟交换机(VSwitch) IP资源不足。
    400DuplicatedParam.AllocationIdThe param of AllocationId is duplicated.AllocationId参数重复，请检查参数。
    400ResourceInConfiguring.VswitchIdThe specified resource of VswitchId is being configured, please try again later.正在配置指定的虚拟交换机资源，请稍后重试。
    400IllegalParamThe param of %s is illegal.输入的参数有值非法，请检查输入。
    400OperationFailed.UnpaidBillThe operation failed because of UnpaidBill.您有欠费账单，不符合购买条件。请先充值结清账单后再购买。
    400OperationDenied.ServiceLinkedRoleNotExistThe operation is not allowed because of ServiceLinkedRoleNotExist.由于服务关联角色不存在（ServiceLinkedRoleNotExist），不允许进行此操作。请检查RAM中是否给NLB进行了授权。
    400ResourceAlreadyAssociated.AllocationIdThe specified resource of %s is already associated.指定的资源AllocationId已经被关联。
    400OperationFailed.vSwitchNotSupportIpv6The operation failed because of vSwitchNotSupportIpv6.所使用的虚拟交换机(vSwicth)不支持ipv6协议，请确认输入参数。
    400InvalidZonesThe current zone list is illegal.Zone maping中使用的可用区非法。
    400QuotaExceeded.QuotaInsufficientThe quota of %s is exceeded, usage %s/%s.配额不足，已使用%s/%s。请在配额中心中修改配额大小。
    400ResourceInUse.IPThe specified resource of IP is in use.传入的IP不能是NLB的eni地址，请检查参数。
    400OperationFailed.CreateOrderErrorOperation failed because CreateOrderError.因为创建订单失败，所以操作失败。
    400OperationFailed.NotExist.ResourceGroupOperation failed because ResourceGroup not exist.指定的资源组不存在。
    400IllegalParam.loadBalancerNameParam loadBalancerName is illegal.实例名称非法，请检查参数。
    400SystemBusySystem is busy, please try again later.系统繁忙，请稍后重试
    400MissingParam.%sThe parameter of %s is missing.参数%s缺失，请检查输入参数。
    400IllegalParam.loadBalancerNameThe parameter loadBalancerName of listener is illegal.NLB负载均衡实例名称不符合输入要求，请根据错误中的详细信息进行修改。
    400IllegalParam.DeletionProtectionConfigDeletionProtectionConfig reason is illegal.更改删除保护状态原因参数非法。
    400IllegalParam.ModificationProtectionConfigModificationProtectionConfig reason is illegal.修改保护原因参数非法。
    400Throttling.UserRequest was denied due to api flow control.由于触发流控，请求被拒绝。
    403UnauthorizedZoneThe specified zone of %s is not authorized.指定的可用区%s未被授权使用
    403Forbidden.NoPermissionAuthentication is failed for NoPermission.因为账号没有权限，所以鉴权失败。
    403UnauthorizedRegionThe specified region of %s is not authorized.当前region还没有获得授权。
    404ResourceNotFound.VSwitchThe specified resource of vSwitch is not found.找不到指定的虚拟交换机资源，请检查输入参数。
    404ResourceNotFound.VpcThe specified resource of Vpc is not found.找不到指定的VPC资源，请检查输入参数。

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2024-09-06OpenAPI 错误码发生变更查看变更详情
    2024-09-04OpenAPI 错误码发生变更查看变更详情
    2024-02-04OpenAPI 错误码发生变更查看变更详情
    2024-02-04OpenAPI 错误码发生变更查看变更详情
    2024-02-04OpenAPI 错误码发生变更查看变更详情
    2024-01-22OpenAPI 错误码发生变更查看变更详情
    2023-12-20OpenAPI 错误码发生变更查看变更详情
    2023-11-27OpenAPI 错误码发生变更查看变更详情
    2023-10-09OpenAPI 错误码发生变更查看变更详情
    2023-09-26OpenAPI 错误码发生变更查看变更详情
    2023-09-12OpenAPI 错误码发生变更查看变更详情
    2023-09-08OpenAPI 错误码发生变更查看变更详情
    2023-09-05OpenAPI 错误码发生变更查看变更详情
    2023-08-22OpenAPI 错误码发生变更查看变更详情
    2023-06-30API 内部配置变更，不影响调用查看变更详情
    2023-06-29OpenAPI 入参发生变更查看变更详情