调用 CreateLoadBalancer 接口,创建一个负载均衡实例。
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateLoadBalancer | 要执行的操作,取值为CreateLoadBalancer。 |
Version | String | 是 | 2020-04-01 | API版本信息,当前版本为:2020-04-01。 |
ExclusiveClusterId | String | 否 | ec-bp1o94dp5i6ea**** | CLB实例所属独占集群的ID。
说明 独占集群功能正在邀测中,暂仅支持完成 企业认证 的账号申请试用,如需试用,请联系客户经理。 |
RegionId | String | 是 | cn-shanghai | 请求的Region。 |
ZoneType | String | 否 | active-standby | CLB实例的可用区类型。
说明 负载均衡支持单可用区部署的功能正在邀测中,暂仅支持完成 企业认证 的账号申请试用,如需试用,请联系客户经理。 |
MasterZoneId | String | 否 | cn-shanghai-a | CLB实例的主可用区ID。各地域当前支持的可用区信息可参见地域与可用区。
|
SlaveZoneId | String | 否 | cn-beijing-b | CLB实例的备可用区ID。
|
LoadBalancerName | String | 否 | clb-test | CLB实例的名称。
|
Description | String | 否 | This is a LB. | CLB实例的描述。
|
LoadBalancerBillingType | Integer | 否 | 2 | CLB实例计费方式。取值如下:
说明 按使用量计费正在邀测中,暂仅支持完成 企业认证 的账号申请试用,如需试用,请联系客户经理。 |
PeriodUnit | String | 否 | Month | 购买包年包月CLB实例的时长单位。
|
Period | Integer | 否 | 1 | 购买包年包月CLB实例的时长。默认为“1”。
|
LoadBalancerSpec | String | 否 | small_1 | CLB实例的规格,不同规格提供的转发能力不同,更多信息请参见产品类型与规格。
说明 参数 |
Type | String | 是 | private | CLB实例的类型。取值如下:
|
AddressIpVersion | String | 否 | ipv4 | CLB实例的IP地址类型。取值如下:
说明 双栈负载均衡功能正在邀测中,暂仅支持完成 企业认证 的账号申请试用,如需试用,请联系客户经理。 |
VpcId | String | 否 | vpc-bp1aevy8sofi8mh1**** | CLB实例所属的VPC ID。
|
SubnetId | String | 是 | subnet-bp12mw1f8k3jgy**** | CLB实例所属VPC内的子网ID。
|
EniAddress | String | 否 | 192.XX.XX.06 | CLB实例的私网IPv4地址。
|
EniAddressNum | Integer | 否 | 2 | CLB实例的私网IPv4地址数量。从子网自动分配指定数量的空闲的IPv4地址。
|
EniIpv6Address | String | 否 | 2408:4005:XX:XX:200 | CLB实例的私网IPv6地址。
|
EipBillingConfig.ISP | String | 否 | BGP | 公网IP线路类型。
说明 除BGP(多线)外,其他线路类型均在邀测中,暂仅支持完成 企业认证 的账号申请试用,如需试用,请联系客户经理。 |
EipBillingConfig.EipBillingType | Integer | 否 | 2 | 公网IP的计费方式。
|
EipBillingConfig.Bandwidth | Integer | 否 | 10 | 公网IP的带宽上限,默认值为1,单位为Mbps。
|
EipBillingConfig.BandwidthPackageId | String | 否 | bwp-2zeo05qre24nhrqpy**** | 公网IP待加入的共享带宽包ID。
|
EipBillingConfig.SecurityProtectionTypes.N | String | 否 | EipBillingConfig.SecurityProtectionTypes.1=AntiDDoS_Enhanced | 公网IP的安全防护类型。
参数 - N:表示安全防护类型的序列,当前仅支持取1。 说明 公网IP的增强防护功能正在邀测中,暂仅支持完成 企业认证 的账号申请试用,如需试用,请联系客户经理。 |
EipBillingConfig.SecurityProtectionInstanceId | Integer | 否 | 20 | DDoS原生防护(企业版)实例的ID。
|
ModificationProtectionStatus | String | 否 | ConsoleProtection | CLB实例是否开启控制台上修改保护。开启后,禁止通过控制台修改实例或删除实例。取值如下:
|
ModificationProtectionReason | String | 否 | 托管实例 | 设置控制台修改保护的原因。
|
ProjectName | String | 否 | default | CLB实例所属项目的名称。不填则默认加入default项目。 |
Tags.N.Key | String | 否 | Tags.1.Key=key1&Tags.2.Key=key2 | 用户标签的标签键。
说明 同一资源的标签键不允许重复。 |
Tags.N.Value | String | 否 | Tags.1.Value=value1&Tags.2.Value=value2 | 用户标签的标签值。
说明 若传入该参数,则必须先传入 |
ClientToken | String | 否 | 123e4567-e89b-12d3-a456-42665544**** | 客户端Token,用于保证请求的幂等性。
|
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
LoadBalancerId | String | clb-bp1o94dp5i6ea**** | CLB实例ID。 |
RequestId | String | 20210811152539010225146063030**** | 请求ID。 |
OrderId | String | Order705261343570982**** | 订单ID。 说明 仅在参数 |
GET /?Action=CreateLoadBalancer&Version=2020-04-01&Type=private&LoadBalancerName=clb-test&VpcId=vpc-bp1aevy8sofi8mh1****&SubnetId=subnet-bp12mw1f8k3jgy****&LoadBalancerSpec=small_1&LoadBalancerBillingType=2 HTTP/1.1 Host: open.volcengineapi.com Region: cn-shanghai Service: clb
{ "ResponseMetadata": { "RequestId": "20210811152539010225146063030****", "Action": "CreateLoadBalancer", "Version": "2020-04-01", "Service": "clb", "Region": "cn-shanghai" }, "Result": { "RequestId": "20210811152539010225146063030****", "LoadBalancerId": "clb-bp1o94dp5i6ea****", "OrderId": "Order705261343570982****" } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | MissingParameter | The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, the 'XXX'. | 该请求缺少必要参数。请确保发起请求已提供全部必要参数,比如XXX。 说明 其中,XXX表示缺少的参数名称。 |
400 | UnsupportedOperation.AccountArrears | The request on the specified instance is denied due to the account in arrears status. | 因账户处于欠费状态,对于该实例的操作请求被拒绝。 |
400 | UnsupportedOperation.AccountArrears | The request on the specified instance is denied due to the account balance and available vouchers are less than 100 yuan in total. | 因账户余额及可用代金券共不足100元,对于该实例的操作请求被拒绝。 |
400 | InvalidBillingType.Malformed | The specified billing type is malformed. | 指定的计费类型不支持。安全防护EIP只支持按带宽上限计费和按流量计费。 |
400 | InvalidBandwidth.Malformed | The specified Bandwidth is malformed. | 指定的 Bandwidth 参数格式不合法。 |
400 | InvalidEipBillingType.Malformed | The specified EipBillingType is malformed. | 指定的 EipBillingType 参数格式不合法。 |
400 | InvalidISP.Malformed | The specified ISP is malformed. | 指定的 ISP 参数格式不合法。 |
400 | QuotaExceed.InstanceNumber | You've reached the limit on the number of instance that you can create. | 已达到可创建负载均衡实例数量的配额上限。 |
400 | QuotaExceed.Eip | You've reached the limit on the number of EIP that you can create. | 已达到可创建公网IP实例数量的配额上限。 |
400 | QuotaExceed.Eni | You've reached the limit on the number of ENI that you can create. | 已达到可创建网卡数量的配额上限。 |
400 | OrderError.PreOrder | Failed to create an order. | 下单失败。 |
400 | OrderError.OrderPay | Failed to create order and pay. | 下单支付失败。 |
400 | IdempotentParameterMismatch | Arguments on this idempotent request are inconsistent with arguments used in previous request(s). | 此幂等请求的参数与前一个请求中使用的参数不一致。 |
400 | InvalidTagKey.Malformed | The specified TagKey is invalid. | 指定的 TagKey 参数格式不合法。 |
400 | InvalidTagValue.Malformed | The specified TagValue is invalid. | 指定的 TagValue 参数格式不合法。 |
400 | InvalidAddressIpVersion.Malformed | The specified AddressIpVersion is malformed. | 指定的 AddressIpVersion 参数格式不合法。 |
400 | LimitExceeded.ServiceManagedTag | You've reached the limit on the number of service managed tags that you can create. | 已达到单次可创建受管资源标签键值数量的上限。 |
400 | LimitExceeded.TagOperation | You've reached the limit on the number of tags that you can operate at a time. | 已达到单次可操作标签数量的上限。 |
400 | InvalidIncorrectOrder.Malformed | The specified index order is malformed. | 指定的索引顺序参数格式不合法。 |
400 | InvalidEniAddress.Malformed | The specified EniAddress is malformed. | 指定的 EniAddress 参数格式不合法。 |
400 | InvalidCount.Malformed | The specified Count is malformed. | 指定的 Count 参数格式不合法。 |
400 | InvalidClientToken.Malformed | The specified ClientToken is malformed. | 指定的 ClientToken 参数格式不合法。 |
400 | InvalidLoadBalancerBillingType.Malformed | The specified LoadBalancerBillingType is malformed. | 指定的 LoadBalancerBillingType 参数格式不合法。 |
400 | InvalidLoadBalancerDescription.Malformed | The specified LoadBalancerDescription is malformed. | 指定的 LoadBalancerDescription 参数格式不合法。 |
400 | InvalidLoadBalancerName.Malformed | The specified LoadBalancerName is malformed. | 指定的 LoadBalancerName 参数格式不合法。 |
400 | InvalidLoadBalancerSpec.Malformed | The specified LoadBalancerSpec is malformed. | 指定的 LoadBalancerSpec 参数格式不合法。 |
400 | InvalidMasterZoneId.Malformed | The specified MasterZoneId is malformed. | 指定的 MasterZoneId 参数格式不合法。 |
400 | InvalidModificationProtectionReason.Malformed | The specified ModificationProtectionReason is malformed. | 指定的 ModificationProtectionReason 参数格式不合法。 |
400 | InvalidModificationProtectionStatus.Malformed | The specified ModificationProtectionStatus is malformed. | 指定的 ModificationProtectionStatus 参数格式不合法。 |
400 | InvalidPeriod.Malformed | The specified Period is malformed. | 指定的 Period 参数格式不合法。 |
400 | InvalidPeriodUnit.Malformed | The specified PeriodUnit is malformed. | 指定的 PeriodUnit 参数格式不合法。 |
400 | InvalidRegionId.Malformed | The specified RegionId is malformed. | 指定的 RegionId 参数格式不合法。 |
400 | InvalidSlaveZoneId.Malformed | The specified SlaveZoneId is malformed. | 指定的 SlaveZoneId 参数格式不合法。 |
400 | InvalidType.Malformed | The specified Type is malformed. | 指定的 Type 参数格式不合法。 |
400 | InvalidEniIpv6Address.Malformed | The specified EniIpv6Address is malformed. | 指定的 EniIpv6Address 参数格式不合法。 |
400 | InvalidAddressIpVersion.Malformed | The specified AddressIpVersion is malformed. | 指定的 AddressIpVersion 参数格式不合法。 |
400 | InvalidSubnetIPv6Cidr.NotSupport | The specified subnet does not support ipv6 cidr. | 指定子网不支持IPv6网段。 |
400 | UnSupportedOperation.AssociatedByPrivateLink | The specified LoadBalancer associated by PrivateLink. | 指定的负载均衡被私网连接绑定。 |
400 | InvalidProject.Malformed | The specified Project is malformed. | 指定的 Project 参数格式不合法。 |
400 | QuotaExceed.ExclusiveClusterInstanceNumber | You've reached the limit on the number of exclusive cluster instance that you can create. | 已达到独占集群可创建负载均衡实例数量的配额上限。 |
400 | InvalidExclusiveCluster.UnSupportAction | The specified ResourceType does not support this action. | 指定的独占集群不支持当前操作。 |
400 | InvalidEniAddressNum.Malformed | The specified EniAddressNum is malformed. | 指定的 EniAddressNum 参数格式不合法。 |
400 | InvalidParameter.EniAddressNumConflictsType | The specified EniAddressNum and Type conflict. | 指定的 EniAddressNum 和 Type 参数冲突。 |
400 | InvalidParameter.EniAddressConflictsEniAddressNum | The specified EniAddress and EniAddressNum conflict. | 指定的 EniAddress 和 EniAddressNum 参数冲突。 |
400 | UnsupportedOperation | The request on the specified instance is denied due to the account in arrears status. | 因账户处于欠费状态,对于该实例的操作请求被拒绝。 |
400 | UnsupportedOperation | The request on the specified instance is denied due to the account balance and available vouchers are less than 100 yuan in total. | 因账户余额及可用代金券共不足100元,对于该实例的操作请求被拒绝。 |
403 | Forbidden | You are not authorized to perform operations on the service managed tag. | 无权限对指定资源打上受管标签。 |
403 | Forbidden | You are not authorized to perform operations on the specified service; for example, the 'EniAddressNum'. | 无权限对指定服务进行操作,比如 EniAddressNum。 |
404 | InvalidProject.NotFound | The specified Project does not exist. | 指定的项目不存在。 |
404 | InvalidVPC.NotFound | The specified VPC does not exist. | 指定的 VPC 不存在。 |
404 | InvalidSubnet.NotFound | The specified Subnet does not exist. | 指定的子网不存在。 |
404 | InvalidEipBillingType.NotFound | The specified EipBillingType does not exist. | 指定的公网 IP 计费方式不存在。 |
404 | InvalidZone.NotFound | The specified Zone mapping does not exist. | 指定主备可用区关系不存在。 |
404 | InvalidExclusiveCluster.NotFound | The specified ExclusiveCluster does not exist. | 指定的独占集群不存在。 |
412 | InvalidExclusiveCluster.Expired | The specified ExclusiveCluster has expired. | 指定的独占集群已过期。 |
412 | InvalidExclusiveCluster.UnPurchased | The specified ExclusiveCluster is not purchased. | 指定的独占集群未购买。 |
412 | IdempotentProcessing | The request uses the same client token as a previous one that is still in process. | 幂等请求处理中。 |