StopListener - Stop an NLB listener - Server Load Balancer

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

nlb:StopListener

update

*LoadBalancer

acs:nlb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

None

Request parameters

Parameter	Type	Required	Description	Example
ListenerId	string	Yes	The listener ID.	lsn-bp1bpn0kn908w4nbw****@80
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: checks the request without performing the operation. The system validates parameter values, request syntax, and service limits. If the check fails, an error message is returned. If it passes, the `DryRunOperation` error code is returned. false (default): sends the request. If validation passes, a 2xx HTTP status code is returned and the operation is performed.	false
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token. The token must be unique across requests and can contain only ASCII characters. Note If you do not specify this parameter, the system uses the request ID as the client token. The request ID is different for each request.	123e4567-e89b-12d3-a456-426655440000
RegionId	string	No	The region ID of the NLB instance. Call the DescribeRegions operation to query available regions.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	The response for stopping a listener.
RequestId	string	The request ID.	CEF72CEB-54B6-4AE8-B225-F876FF7BA984
JobId	string	The ID of the asynchronous task.	72dcd26b-f12d-4c27-b3af-18f6aed5****

Examples

Success response

JSON format

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	SystemBusy	System is busy, please try again later.
400	IncorrectStatus.listener	The status of listener [%s] is incorrect.	The listener status does not allow this operation. Verify that no other operations are in progress on the listener.
400	DryRunOperation	Request validation has been passed with DryRun flag set.	Request validation has been passed with DryRun flag set.
403	Forbidden.NoPermission	Authentication is failed for NoPermission.	Authentication is failed for NoPermission.
404	ResourceNotFound.listener	The specified resource %s is not found.
404	ResourceNotFound.loadBalancer	The specified resource of loadbalancer is not found.	The specified load balancer was not found. Check the input parameters.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.