文档首页 > > API参考> SQL作业相关API> 数据库相关API>

删除数据库

删除数据库

分享
更新时间:2021/05/17 GMT+08:00

功能介绍

该API用于删除空数据库,默认方式下,若待删除的数据库中存在表,则需先删除其中的所有表。删除表API请参见删除表

调试

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

URI

  • URI格式:

    DELETE /v1.0/{project_id}/databases/{database_name}

  • 参数说明
    表1 URI 参数

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

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

    database_name

    String

    删除的数据库名称。

    表2 query 参数

    参数名称

    是否必选

    参数类型

    说明

    cascade

    Boolean

    是否强制删除数据库,取值为“true”或者“false”。默认值为:false。

    async

    Boolean

    是否异步方式删除数据库,取值为“true”或者“false”。默认值为:false。

    带入query参数的URL示例如下:

    DELETE /v1.0/{project_id}/databases/{database_name}?cascade={is_cascade}&async={is_asyn}

请求消息

无请求参数。

响应消息

表3 响应参数

参数名称

是否必选

参数类型

说明

is_success

Boolean

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

message

String

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

job_id

String

返回作业的ID,可用于获取作业状态和作业结果。

job_type

String

作业类型。

  • DDL
  • DCL
  • IMPORT
  • EXPORT
  • QUERY
  • INSERT

job_mode

String

作业执行模式:

  • async:异步
  • sync:同步

示例

  • 请求样例:
    None
  • 同步方式请求成功响应样例:
    {
     "is_success": true,
     "message": "",
     "job_mode": "sync"
    }
  • 异步方式请求成功响应样例:
    {
     "is_success": true,
     "message": "",
     "job_id": "208b08d4-0dc2-4dd7-8879-ddd4c020d7aa",
     "job_type": "DDL",
     "job_mode": "async"
    }
    • 如果通过异步方式删除数据库,可以通过查询作业状态接口查看当前作业的状态,详细介绍参见查询作业状态
    • 如果强制删除数据库cascade=true,则会级联删除该数据库下面的所有表,需要谨慎使用。

状态码

状态码如表4所示。

表4 状态码

状态码

描述

200

删除成功。

400

请求错误。

500

内部服务器错误。

错误码

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

分享:

    相关文档

    相关产品