Delete Application Load Balancer Listener - DeleteListener
Overview
Delete an application load balancer listener
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is DeleteListener . | Yes |
PublicKey | string | The user's public key can be obtained from Console (opens in a new tab) | Yes |
Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Region | string | Region. See List of Regions and Availability Zones | Yes |
ProjectId | string | Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface. | Yes |
LoadBalancerId | string | ID of the Application Load Balancer Instance | Yes |
ListenerId | string | ID of the Application Load Balancer Listener | Yes |
RelatedRedirectDisabled | boolean | Whether to turn off the redirection function of the related listener. The default is false, that is, if other listeners are redirected to this listener, the deletion will fail. When it is true, it will first turn off the redirection function of the related listener, and then delete this listener. The default value is: false | Yes |
Response Field
Field Name | Type | Description Information | Required |
---|---|---|---|
RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
Action | string | Operation command name. | Yes |
Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
Example
Request Example
https://api.surfercloud.com/?Action=DeleteListener
&Region=cn-zj
&ProjectId=org-XXXXX
&LoadBalancerId=alb-XXXXX
&ListenerId=als-XXXXX
&RelatedRedirectDisabled=true
Response Example
{
"Action": "DeleteListenerResponse",
"RetCode": 0
}