All Products
Search
Document Center

Server Load Balancer:StartLoadBalancerListener

Last Updated:Mar 14, 2024

Enables a listener.

Operation description

When you call this operation, note the following items:

  • You can call the operation only when the listener is in the Stopped state.
  • After the operation is called, the status of the listener changes to Starting.
  • You cannot call this operation when the SLB instance to which the listener is bound is in the Locked state.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The region where the SLB instance is deployed.

You can retrieve the region ID by calling the DescribeRegions operation.

cn-hangzhou
LoadBalancerIdstringYes

The ID of the SLB instance.

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

The listener port of the SLB instance.

Valid values: 1 to 65535.

80
ListenerProtocolstringNo

The protocol used by the listener of the SLB instance.

Note If different listeners use the same port, you must specify this parameter.
https

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

CEF72CEB-54B6-4AE8-B225-F876FF7BA984

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError message
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.

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

Change history

Change timeSummary of changesOperation
2023-09-08The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change