更新时间:2022-09-16 GMT+08:00
分享

删除队列

功能介绍

该API用于删除指定队列。

若指定队列正在执行任务,则不允许删除。

调试

您可以在API Explorer中调试该接口。

URI

  • URI格式:

    DELETE /v1.0/{project_id}/queues/{queue_name}

  • 参数说明
    表1 URI参数

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

    项目编号,用于资源隔离。获取方式请参考获取项目ID

    queue_name

    String

    指定删除的队列名称。

请求消息

无请求参数。

响应消息

表2 响应参数

参数名称

是否必选

参数类型

说明

is_success

Boolean

请求执行是否成功。“true”表示请求执行成功。

message

String

系统提示信息,执行成功时,信息可能为空。

请求示例

响应示例

{
  "is_success": true,
  "message": ""
}

状态码

状态码如表3所示。

表3 状态码

状态码

描述

200

删除成功。

400

请求错误。

500

内部服务器错误。

错误码

调用接口出错后,将不会返回上述结果,而是返回错误码和错误信息,更多介绍请参见错误码

相关文档