All Products
Search

This Product

    Server Load Balancer:StopListener

    Document Center

    Server Load Balancer:StopListener

    Last Updated:Mar 13, 2024

    Stops a listener of a Network Load Balancer (NLB) instance.

    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
    nlb:StopListenerWrite
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ListenerIdstringYes

    The listener ID.

    		lsn-bp1bpn0kn908w4nbw****
    DryRunbooleanNo

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

    • true: performs 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 message 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 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
    RegionIdstringNo

    The region ID of the NLB instance.

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

    		cn-hangzhou

    Response parameters

    ParameterTypeDescriptionExample
    object

    The operation to disable a listener.

    RequestIdstring

    The request ID.

    		CEF72CEB-54B6-4AE8-B225-F876FF7BA984
    JobIdstring

    The ID of the asynchronous task.

    		72dcd26b-f12d-4c27-b3af-18f6aed5****

    Examples

    Sample success responses

    JSONformat

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

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    2024-02-29The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 404
      Added Error Codes: 403
    2023-12-18The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 404
    2023-10-09The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 404
    2023-09-26The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      Added Error Codes: 404
    2023-08-22The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Added Error Codes: 400