调用StartListener启动监听。

使用说明

StartListener接口属于异步接口,即系统返回一个请求ID,但该监听尚未启动成功,系统后台的启动任务仍在进行。您可以调用GetListenerAttribute查询监听的启动状态:

  • 当监听处于Configuring状态时,表示监听正在启动中。
  • 当监听处于Running状态时,表示监听启动成功。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String StartListener

要执行的操作。

取值:StartListener

ListenerId String lsr-bp1bpn0kn908w4nbw****

应用型负载均衡实例监听的ID。

ClientToken String 5A2CFF0E-5718-45B5-9D4D-70B3FF3898

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

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

说明 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
DryRun Boolean true

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

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

返回数据

名称 类型 示例值 描述
JobId String 72dcd26b-f12d-4c27-b3af-18f6aed5****

异步任务ID。

RequestId String 365F4154-92F6-4AE4-92F8-7FF34B540710

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=StartListener
&ListenerId=lsr-bp1bpn0kn908w4nbw****
&ClientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF3898
&DryRun=true
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<StartListenerResponse>
    <JobId>72dcd26b-f12d-4c27-b3af-18f6aed5****</JobId>
    <RequestId>365F4154-92F6-4AE4-92F8-7FF34B540710</RequestId>
</StartListenerResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "JobId" : "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "RequestId" : "365F4154-92F6-4AE4-92F8-7FF34B540710"
}

错误码

HttpCode 错误码 错误信息 描述
400 IncorrectStatus.LoadBalancer The status of %s [%s] is incorrect. 资源%s [%s]的状态无效。
400 IncorrectBusinessStatus.LoadBalancer The business status of %s [%s]  is incorrect. 资源%s [%s]的业务状态无效。
400 IncorrectStatus.Listener The status of %s [%s] is incorrect. 资源%s [%s]的状态无效。
404 ResourceNotFound.Listener The specified resource %s is not found. 资源%s不存在。

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