文档首页/ 分布式数据库中间件 DDM/ API参考（吉隆坡区域）/ DDM实例管理/ 删除DDM实例
更新时间：2022-08-16 GMT+08:00
查看PDF
分享

删除DDM实例

功能介绍

删除指定的DDM实例，释放该实例的所有资源。

接口约束

无

URI

DELETE /v1/{project_id}/instances/{instance_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

instance_id

是

String

DDM实例ID。
表2 Query参数

参数

是否必选

参数类型

描述

delete_rds_data

否

Boolean

是否同时删除关联RDS上存储的数据。

  • 取值为空或“true”：删除。
  • 取值为“false”：不删除。

默认为空。

说明：

True、False取值对大小写不敏感。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

id

String

DDM实例ID。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

errCode

String

业务错误码

externalMessage

String

错误信息

状态码： 500

表6 响应Body参数

参数

参数类型

描述

errCode

String

业务错误码

externalMessage

String

错误信息

请求示例

DELETE https://{endpoint}/v1/{project_id}/instances/{instance_id}?delete_rds_data=true

响应示例

状态码： 200

OK

{
  "id" : "9608ce63-bf66-4342-be8a-44f9b6b15d54"
}

状态码： 400

bad request

{
  "externalMessage" : "Parameter error.",
  "errCode" : "DBS.280001"
}

状态码： 500

server error

{
  "externalMessage" : "Parameter error.",
  "errCode" : "DBS.280001"
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： DDM实例管理