OkayAPI Docs


API Path: /api/App/MongoDB/DataDeleteOneData

API Description: MongoDB-精确查找删除一份文档

1
API Traffic
HTTP/HTTPS
Protocol
GET/POST
Method
UTF-8
Charset
JSON
Response

API Debug   


API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
collectionStringRequired集合名称
filterArrayJSON FormatOptaion[]查找文档的条件,查找全部传空对象或不传。
比较查询
  • $eq:相等
  • $gt:大于
  • $gte:大于等于
  • $in:在指定数组内
  • $lt:小于
  • $lte:小于等于
  • $nin:不在指定数组内
逻辑查询
  • $and:逻辑AND
  • $not:逻辑非
  • $nor:逻辑NOR
  • $or:逻辑或
元素查询
  • $exists:是否存在指定字段
  • $type:字段是否为指定类型
数组查询
  • $all:包含全部数组元素
  • $elemMatch:元素匹配
  • $size:匹配数量
更多查询操作请见MongoDB官方文档。

API Debug

KEYREQUIREDVALUE
app_key *Required
collection *Required
filter Option

API Response

KEYTypeDescription
err_codeInt操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景
err_msgString错误提示信息,err_code非0时参考此提示信息
ResultObjectMongoDB结果,失败时返回Null
Result.DeletedCountInt删除的数量

HTTP Response Code

HTTP Status CodeDescription
Http Status = 200Success
Http Status = 400Illegal-Params
Http Status = 401Illegal-Token
Http Status = 402IP-Banned
Http Status = 404API-NOT-Exsits
Http Status = 406Illegal-APPKEY
Http Status = 407APPKEY-Expired-Out
Http Status = 408APPKEY-Busy
Http Status = 409Illegal-Sign
Http Status = 413API-Traffic-NOT-Enough
Http Status = 415API-LOCKED
Http Status = 500Internal-Server-Error