StopListener - 停止监听

停止网络型负载均衡实例的监听。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
nlb:StopListenerupdate
  • LoadBalancer
    acs:nlb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

请求参数

名称类型必填描述示例值
ListenerIdstring

监听 ID。

lsn-bp1bpn0kn908w4nbw****@80
DryRunboolean

是否只预检此次请求。取值:

  • true:发送检查请求,不会停止监听。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后返回 HTTP 2xx 状态码并直接进行操作。
false
ClientTokenstring

客户端 Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
123e4567-e89b-12d3-a456-426655440000
RegionIdstring

网络型负载均衡实例所在的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou

返回参数

名称类型描述示例值
object

停止监听。

RequestIdstring

请求 ID。

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

异步任务 ID。

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

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400SystemBusySystem is busy, please try again later.系统繁忙,请稍后重试
400IncorrectStatus.listenerThe status of listener [%s] is incorrect.监听的状态无法进行当前操作,请检查监听当前是否处于其他操作下。
400DryRunOperationRequest validation has been passed with DryRun flag set.dryRun请求验证已通过。
403Forbidden.NoPermissionAuthentication is failed for NoPermission.因为账号没有权限,所以鉴权失败。
404ResourceNotFound.listenerThe specified resource %s is not found.资源%s不存在。
404ResourceNotFound.loadBalancerThe specified resource of loadbalancer is not found.找不到指定的负载均衡器资源,请检查输入参数。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-03-21OpenAPI 错误码发生变更查看变更详情
2024-02-29OpenAPI 错误码发生变更查看变更详情
2023-12-18OpenAPI 错误码发生变更查看变更详情
2023-10-09OpenAPI 错误码发生变更查看变更详情
2023-09-26OpenAPI 错误码发生变更查看变更详情
2023-08-22OpenAPI 错误码发生变更查看变更详情