文档首页> 云数据库 GaussDB(for MySQL)> API参考> API（推荐）> 实例管理> 删除/退订实例
更新时间：2023-10-23 GMT+08:00
在线调试
CLI示例
查看PDF

删除/退订实例

功能介绍

删除数据库实例。

URI

DELETE /v3/{project_id}/instances/{instance_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的project ID。

获取方法请参见获取项目ID。

instance_id

是

String

实例ID，严格匹配UUID规则。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

否

String

请求语言类型。默认en-us。

取值范围：

  • en-us
  • zh-cn

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

job_id

String

任务ID。

order_id

String

订单号，仅包年/包月返回该参数。

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

  • 删除按需数据库实例。
    DELETE https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07
  • 退订包年/包月实例。
    DELETE https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07

响应示例

状态码： 200

Success.

  • 按需实例
    {
  "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"
}
  • 包年/包月实例
    {
  "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890",
  "order_id" : "CS2305230939BMXV8"
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 实例管理