DeleteListener--应用型负载均衡-火山引擎

文档中心

立即注册

导航

DeleteListener

最近更新时间：2024.06.28 16:26:01首次发布时间：2022.05.20 21:30:45

请求说明

API 名称：DeleteListener。
API 域名：open.volcengineapi.com 。
API 描述：删除监听器，只有状态为已停止的监听器才可进行删除操作。

使用限制

节流限制：每秒最多提交 5 个 API 请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

URI 参数

在使用该部分 API 提交请求时必须包含以下 URI 参数。

除了 URI 参数，该 API 请求还需要包含签名参数。关于更多签名参数的信息，参见公共请求参数。

名称	类型	是否必选	格式	说明
Action	string	是	[a-zA-Z]+	API 名称，如 DeleteListener
Version	string	是	YYYY-MM-DD	API 版本信息。该参数的取值是 2020-04-01 。
X-Expires	int	否	900	表示签名的有效时间，单位是秒，默认值是900。

请求参数

在使用该 API 提交请求时，请求参数中可以包含的参数如下。

参数	类型	是否必选	参数说明	示例值
ListenerId	String	是	待删除的监听器ID。	lsn-abc******

返回参数

参数	类型	参数说明	示例值
RequestId	String	请求ID。	20210816110638****2514606306AF947C

示例

请求示例

GET /?Action=DeleteListener&Version=2020-04-01&ListenerId=lsn-3ciw6t6efwef46c6rrtdhxu36 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: alb

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20210816110638****2514606306AF947C",
        "Action": "DeleteListener",
        "Version": "2020-04-01",
        "Service": "alb",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "202108161106****22514606306AF947C",
    }
}

错误码

如果响应正文包含 Error 字段，则表示 API 请求失败。此处仅展示当前 API 的错误码，更多错误码请参见公共错误码。

HTTP Code	错误码	错误信息	错误描述
400	InvalidListener.InvalidStatus	The specified Listener is not in the correct status for the request.	指定的监听器所处状态无法响应该请求。
400	InvalidListenerCustomRule.InUse	The specified Listener is being used by custom rules.	指定的监听器正在被自定义转发规则使用。
400	OperationFailed.RemoveFromProjectFailed	The request on the specified resource failed due to removing it from the project failed.	因将资源从项目中移除失败，对于该资源的操作请求失败。
400	InvalidServerGroup.InvalidStatus	The specified ServerGroup is not in the correct status for the request.	指定的服务器组所处状态无法响应该请求。
400	InvalidLoadBalancer.InvalidStatus	The specified LoadBalancer is not in the correct status for the request.	指定的 ALB 实例所处状态无法响应该请求。
404	InvalidListener.NotFound	The specified Listener does not exist.	指定的监听器不存在。