更新时间:2024-07-22 GMT+08:00
分享

删除数据

功能介绍

删除指定服务实例中的对应数据,支持指定ID删除和条件删除。

调试

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

URI

POST /v2/{project_id}/mms/{service_name}/data/delete

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

用户的项目ID。获取方法请参见获取项目ID和名称

service_name

String

服务实例的名称,用户创建服务实例时指定。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

force

Boolean

是否幂等删除数据,默认为false。仅对指定ID删除生效。

  • false: 数据不存在时返回错误信息。
  • true: 数据不存在时返回成功,用于幂等删除场景。

item_id

String

数据的服务实例级唯一标识,字符长度范围为[1, 256]。

  • item_id/custom_tags/custom_num_tags中必须给定至少一个参数,以支持对服务实例中的数据进行指定ID删除或条件删除。
  • 如给定item_id参数,则进行指定ID删除,否则进行条件删除。

custom_tags

Map<String,Array<String>>

自定义字符标签,用于对服务实例中的数据进行条件删除。格式为键值对{key:value}。

  • key: 必须为服务实例custom_tags中已存在的key,可在创建服务实例时进行配置,或在更新服务实例时进行新增。
  • value: 标签值列表,列表内多个标签值为“或”关系,即满足一个即可。列表长度范围为[1, 32],标签值类型为字符串,字符长度范围为[1, 64]。

custom_num_tags

Map<String,RangeParam>

自定义数值标签,用于对服务实例中的数据进行custom_num_tags条件删除。格式为键值对{key:value}。

  • key: 必须为服务实例custom_num_tags中已存在的key,可在创建服务实例时进行配置,或在更新服务实例时进行新增。针对没有设置该数值标签的数据,会直接过滤。
  • value: 标签值的取值范围,标签值在给定的取值范围内即视为符合条件。
表3 RangeParam

参数

是否必选

参数类型

描述

from

Double

数值下界,默认包含该下界。

to

Double

数值上界,默认包含该上界。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

result

String

删除数据完成返回success。

data

DeleteRestInfo object

删除数据的相关信息,仅在条件删除时存在该字段。

表5 DeleteRestInfo

参数

参数类型

描述

items

Array of items objects

删除数据列表。

delete_info

DeleteInfo object

删除结果的相关信息。

表6 items

参数

参数类型

描述

id

String

数据唯一ID。

表7 DeleteInfo

参数

参数类型

描述

total_num

Integer

符合条件的结果总数。

delete_num

Integer

本次删除的结果总数,目前一次请求最多删除100条结果。

状态码: 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

调用失败时的错误码,具体请参见错误码

调用成功时无此字段。

error_msg

String

调用失败时的错误信息。

调用成功时无此字段。

请求示例

删除数据

POST https://{endpoint}/v2/{project_id}/mms/{service_name}/data/delete

{
  "item_id" : "electronics_01"
}

响应示例

状态码: 200

成功响应示例

{
  "result" : "success"
}

状态码: 400

失败响应示例

{
  "error_code" : "MMS.0003",
  "error_msg" : "Invalid parameter: item_id"
}

状态码

状态码

描述

200

成功响应示例。

400

失败响应示例。

错误码

请参见错误码

分享:

    相关文档

    相关产品