All Products
Search

This Product

    Server Load Balancer:CreateLoadBalancer

    Document Center

    Server Load Balancer:CreateLoadBalancer

    Last Updated:Nov 11, 2024

    Creates a Gateway Load Balancer (GWLB) instance.

    Operation description

    Make sure that you fully understand the billing methods and pricing of GWLB before calling this operation.

    • When you create a GWLB instance, the service-linked role AliyunServiceRoleForGwlb is automatically created.

    • CreateLoadBalancer is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the GetLoadBalancerAttribute operation to query the status of a GWLB instance.

      • If the GWLB instance is in the Provisioning state, the GWLB instance is being created.
      • If the GWLB instance is in the Active state, the GWLB instance is created.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    gwlb:CreateLoadBalancercreate
    • LoadBalancer
      acs:gwlb:{#regionId}:{#accountId}:loadbalancer/*
    • VSwitch
      acs:vpc:{#regionId}:{#accountId}:vswitch/{#VSwitchId}
    • VPC
      acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    AddressIpVersionstringNo

    The IP version. Valid values:

    • Ipv4 (default): IPv4
    		IPv4
    LoadBalancerNamestringNo

    The GWLB instance name.

    The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.

    		testGwlbName
    VpcIdstringYes

    The virtual private cloud (VPC) ID.

    		vpc-uf6qcgpv22ttrnnjh****
    ZoneMappingsarray<object>Yes

    The mappings between zones and vSwitches. You must specify at least one zone. You can specify at most 20 zones. If the region supports two or more zones, specify at least two zones.

    ZoneEniModelobjectYes
    VSwitchIdstringYes

    The ID of the vSwitch in the zone. You can specify only one vSwitch (subnet) in each zone of a GWLB instance.

    		vsw-2f0eb020****
    ZoneIdstringYes

    The zone ID. You can call the DescribeZones operation to query the most recent zone list.

    		cn-hangzhou-a
    Tagarray<object>No

    The tag keys. You can specify at most 20 tags in each call.

    TagModelobjectNo
    KeystringNo

    The tag key. The tag key cannot be an empty string.

    The tag key can be up to 128 characters in length. The tag key cannot start with aliyun or acs:, and cannot contain http:// or https://.

    		testTagKey
    ValuestringNo

    The tag value. The tag value can be up to 256 characters in length and cannot contain http:// or https://.

    		testTagValue
    ResourceGroupIdstringNo

    The resource group ID.

    		rg-acfmwbufq6q3****
    DryRunbooleanNo

    Specifies whether to perform a dry run, without performing the actual request. Valid values:

    • true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error code is returned. If the request passes the dry run, the DryRunOperation error code is returned.
    • false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
    		false
    ClientTokenstringNo

    The client token that is used to ensure the idempotence of the request.

    You can use the client to generate the token, but you must make sure that the token is unique among different requests. The client token can contain only ASCII characters.

    Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
    		123e4567-e89b-12d3-a456-426655440000

    Response parameters

    ParameterTypeDescriptionExample
    object
    LoadBalancerIdstring

    The GWLB instance ID.

    		gwlb-9njtjmqt7zfcqm****
    RequestIdstring

    The request ID.

    		00B19438-66BB-58C3-8C2F-DA5B6F95CBDA

    Examples

    Sample success responses

    JSONformat

    {
  "LoadBalancerId": "gwlb-9njtjmqt7zfcqm****",
  "RequestId": "00B19438-66BB-58C3-8C2F-DA5B6F95CBDA"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400DuplicatedParam.ZoneIdThe param of ZoneId is duplicated.Duplicate ZoneId parameter in list
    400OperationDenied.VSwitchNotSupportIpv6The operation is not allowed because of VSwitchNotSupportIpv6.IPv6 is not enabled in the Vswitch. The operation is not supported.
    400ResourceNotEnough.VSwitchIpThe specified resource of VSwitchIp is not enough.Insufficient VSwitch IP resources
    400DuplicatedParam.VSwitchIdThe param of VSwitchId is duplicated.Duplicate VSwitchId parameter in list
    400IllegalParamSize.ZoneMappingsThe param size of ZoneMappings is illegal.Illegal number of ZoneMappings lists
    400Mismatch.ZoneIdAndVSwitchIdThe ZoneId and VSwitchId are mismatched.The value of the ZoneId parameter does not match that of the VSwitchId
    400QuotaExceeded.LoadBalancersNumThe quota of %s is exceeded for resource %s, usage %s/%s.The quota gwlb_quota_loadbalancers_num has exceeded the quota limit.
    400DuplicatedParam.TagKeyThe param of %s is duplicated.The parameter of tag key is duplicated.
    400IllegalParam.TagKeyThe param of %s is illegal.-

    For a list of error codes, visit the Service error codes.