更新时间:2025-11-28 GMT+08:00
分享

删除实例V3

功能介绍

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

接口约束

不支持删除包周期实例。

调试

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

URI

  • URL格式

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

  • 参数说明
    表1 路径参数

    参数

    是否必选

    参数类型

    描述

    project_id

    String

    租户在某一region下的project ID。

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

    instance_id

    String

    DDM实例ID。

    表2 Query参数

    参数

    是否必选

    参数类型

    描述

    delete_dn_data

    Boolean

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

    取值为true:删除。

    取值为空或false:不删除。

请求

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务的“获取用户Token”接口来获取。

请求示例

删除实例(删除关联后端数据库实例上存储的数据)。
DELETE https://{endpoint}/v3/{project_id}/instances/{instance_id}?delete_dn_data=true
删除实例(保留关联后端数据库实例上存储的数据)。
DELETE https://{endpoint}/v3/{project_id}/instances/{instance_id}?delete_dn_data=false

响应消息

  • 正常响应参数说明
    表4 响应Body参数

    参数

    参数类型

    描述

    job_id

    String

    删除DDM实例的任务ID。

  • 正常响应示例
    {
     "job_id": "eff1d289-xxxx-xxxx-8b9f-463ea07c000c"
    }
  • 异常响应

    请参见异常请求结果

状态码

错误码

请参见错误码

相关文档