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

文档中心

立即注册

导航

DeleteRules

最近更新时间：2024.06.28 16:26:03首次发布时间：2022.05.20 22:34:43

请求说明

API 名称：DeleteRules。
API 域名：open.volcengineapi.com 。
API 描述：删除指定监听器转发规则。

使用限制

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

调试

API Explorer

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

去调试

URI 参数

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

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

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

请求参数

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

参数	类型	是否必选	参数说明	示例值
ListenerId	String	是	监听器ID。	lsn-2fea4ayvu2g3k5oxruuz****
RuleIds.N	List of String	是	转发规则的ID，转发规则必须属于对应的监听器。如果传入的转发规则都不存在，则报错。参数 - N：表示转发规则的序号，取值1 ～ 20。多个转发规则间使用“&”分隔。	RuleIds.1=rule-** &RuleIds.2=rule-**

参数

类型

是否必选

参数说明

示例值

ListenerId

String

是

监听器ID。

lsn-2fea4ayvu2g3k5oxruuz****

RuleIds.N

List of String

是

转发规则的ID，转发规则必须属于对应的监听器。如果传入的转发规则都不存在，则报错。

参数 - N：表示转发规则的序号，取值1 ～ 20。
多个转发规则间使用“&”分隔。

RuleIds.1=rule-**** &RuleIds.2=rule-****

返回参数

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

示例

请求示例

GET /?Action=DeleteRules&ListenerId=lsn-1g0puwcx****8g8ibuxxw2pmf7&RuleIds.1=rule-1g0pux***a9s8ibuxy0p2l88&Version=2020-04-01 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: alb

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021081317494****22514214202F3FE94",
        "Action": "DeleteRules",
        "Version": "2020-04-01",
        "Service": "alb",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "2021081317494801022514214202F3FE94"
    }
}

错误码

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

HTTP Code	错误码	错误信息	错误描述
404	InvalidListener.NotFound	The specified Listener does not exist.	指定的监听器不存在。
400	LimitExceed.Rule	You've reached the limit on the number of rules that you can operate at a time.	已达到单次可操作的转发规则的数量上限。
400	InvalidRuleIds.Duplicated	The specified RuleIds is duplicated.	指定的 RuleIds 重复。
403	Forbidden	You are not authorized to perform operations on the default rule.	您无权限对默认转发规则进行操作。
404	InvalidRule.NotFound	The specified Rule does not exist.	指定的转发规则不存在。
400	InvalidLoadBalancer.InvalidStatus	The specified LoadBalancer is not in the correct status for the request.	指定的 ALB 实例所处状态无法响应该请求。
400	InvalidServerGroup.InvalidStatus	The specified ServerGroup is not in the correct status for the request.	指定的服务器组所处状态无法响应该请求。