文档首页/ 分布式数据库中间件 DDM/ API参考/ API（推荐）/ 实例管理/ 删除DDM实例
更新时间：2024-11-01 GMT+08:00
查看PDF
分享

删除DDM实例

功能介绍

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

接口约束

无

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一region下的project ID。

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

instance_id

是

String

DDM实例ID。
表2 Query参数

参数

是否必选

参数类型

描述

delete_rds_data

否

String

是否同时删除关联后端数据库实例上存储的数据。

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

枚举值：

  • true
  • false

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务的“获取用户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
  • 删除实例，保留关联后端数据库实例上存储的数据。 
    DELETE https://{endpoint}/v1/{project_id}/instances/{instance_id}?delete_rds_data=false

响应示例

状态码： 200

OK

{
  "id" : "9608ce63-bf66-4342-be8a-44f9b6b15d54",
  "job_id" : "1c403d1d-d3e9-4b3e-9750-7cd6a58376d9"
}

状态码： 400

bad request

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

状态码： 500

server error

{
  "externalMessage" : "Server failure.",
  "errCode" : "DBS.200412"
}

状态码

状态码

描述

200

OK

400

bad request

500

server error

错误码

请参见错误码。

父主题： 实例管理

相关文档