All Products
Search
Document Center

Server Load Balancer:StartLoadBalancerListener

Last Updated:Oct 11, 2024

Enables a listener.

Operation description

When you call this operation, take note of the following items:

  • You can call the operation only when the listener is in the Stopped state.
  • If the operation is successful, the listener switches to the Starting state.
  • You cannot perform this operation when the Classic Load Balancer (CLB) instance to which the listener belongs is in the Locked state.

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
slb:StartLoadBalancerListenerupdate
  • loadbalancer
    acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}
  • slb:tag
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The region where the CLB instance is created.

You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
LoadBalancerIdstringYes

The CLB instance ID.

lb-bp13jaf5qli5*********
ListenerPortintegerYes

The frontend port that is used by the CLB instance.

Valid values: 1 to 65535.

80
ListenerProtocolstringNo

The frontend protocol that is used by the CLB instance.

Note This parameter is required if the same port is used by listeners of different protocols.
https

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

CEF72CEB-54B6-4AE8-B225-F876FF7BA984

Examples

Sample success responses

JSONformat

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
}

Error codes

HTTP status codeError codeError messageDescription
400Operation.DenyThe specified listener is configuring, please try again later.-
400TooManyListenersMore than 1 listener is found, please be more specified.-
400Operation.NotAllowedThe specified listener is not allowed to operate.-
400SystemBusyThe system is busy.The service is unavailable. Please try again later.

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

Change history

Change timeSummary of changesOperation
2023-09-08The Error code has changedView Change Details