You need to enable JavaScript to run this app.
导航
DeleteDBInstance
最近更新时间:2024.10.17 14:42:41首次发布时间:2022.04.12 11:06:53

调用 DeleteDBInstance 接口删除目标 MongoDB 实例。

请求类型

异步请求。

注意事项

  • 当前仅按量计费(即实例计费类型 ChargeType 取值为 PostPaid)的 MongoDB 实例支持调用 DeleteDBInstance 接口来删除实例。删除时,系统会主动发起一次备份来保存删除前的所有数据。您可以在已删除实例备份页查看已删除实例的备份详情。
  • 您可以通过控制台或费用中心来退订(即删除)包年包月的 MongoDB 实例。具体操作步骤,请参见退订包年包月实例。退订包年包月实例时不支持选择实例备份保留策略,系统会主动发起一次备份来保存删除前的所有数据。您可以在已删除实例备份页查看已删除实例的备份详情。
  • 已删除实例备份的保留期默认为 7 天。 如有需要,建议您及时通过已删除实例备份将数据恢复至新实例,具体操作步骤,请参见恢复已删除实例。否则实例删除且已删除实例的备份超过保留期后,所有节点及所有数据将被彻底清除且不可恢复。

请求参数

参数
类型
是否必选
示例值
描述
InstanceId
String
mongo-replica-e405f8e2****

实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询目标地域下所有 MongoDB 实例的基本信息,包括实例 ID。

返回参数

本接口无特有的返回参数。更多信息请见返回结构

示例

请求示例

POST https://mongodb.volcengineapi.com/?Action=DeleteDBInstance&Version=2022-01-01 HTTP/1.1
Host: mongodb.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/mongodb/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "InstanceId": "mongo-replica-e405f8e2****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202202211539050101742350380678****",
        "Action": "DeleteDBInstance",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
    "Result": null
}

错误码

更多详情,请参见错误码