删除数据 V2
功能介绍
删除指定服务实例中的对应数据,支持指定ID删除和条件删除。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v2/{project_id}/mms/{service_name}/data/delete
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
用户的项目ID。获取方法请参见获取项目ID和名称。 |
service_name |
是 |
String |
服务实例的名称,用户创建服务实例时指定。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
force |
否 |
Boolean |
是否幂等删除数据,默认为false。仅对指定ID删除生效。
|
item_id |
否 |
String |
数据的服务实例级唯一标识,字符长度范围为[1, 256]。
|
custom_tags |
否 |
Map<String,Array<String>> |
自定义字符标签,用于对服务实例中的数据进行条件删除。格式为键值对{key:value}。
|
custom_num_tags |
否 |
Map<String,RangeParam> |
自定义数值标签,用于对服务实例中的数据进行custom_num_tags条件删除。格式为键值对{key:value}。
|
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
result |
String |
删除数据完成返回success。 |
data |
DeleteRestInfo object |
删除数据的相关信息,仅在条件删除时存在该字段。 |
参数 |
参数类型 |
描述 |
---|---|---|
items |
Array of items objects |
删除数据列表。 |
delete_info |
DeleteInfo object |
删除结果的相关信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
total_num |
Integer |
符合条件的结果总数。 |
delete_num |
Integer |
本次删除的结果总数,目前一次请求最多删除100条结果。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
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 |
失败响应示例。 |
错误码
请参见错误码。