Stops a listener of a Network Load Balancer (NLB) instance.
Debugging
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| nlb:StopListener | update |
|
| 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, without performing the actual request. Valid values:
| 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, but you must make sure that the token is unique among different requests. The 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 |
| RegionId | string | No | The region ID of the NLB instance. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
Response parameters
Examples
Sample success responses
JSONformat
{
"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 current operation cannot be performed on the listener as its status is unavailable. Please check if the listener is currently undergoing any other operations. |
| 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 resource was not found. Please check the input parameters. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-03-21 | The Error code has changed | View Change Details |
| 2024-02-29 | The Error code has changed | View Change Details |
| 2023-12-18 | The Error code has changed | View Change Details |
| 2023-10-09 | The Error code has changed | View Change Details |
| 2023-09-26 | The Error code has changed | View Change Details |
| 2023-08-22 | The Error code has changed | View Change Details |