OkayAPI Docs
API Params
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
collection | String | Required | 集合名称 | ||
filter | ArrayJSON Format | Optaion | [] | 查找文档的条件,查找全部传空对象或不传。
比较查询
| |
projection | Array | Optaion | [] | 指定返回的字段,JSON格式,类如:projection={"age":1,"name":0},0返回字段1不返回字段 | |
num | Int | Optaion | 1 | MIN: 1 | 获取数量 |
API Debug
KEY | REQUIRED | VALUE |
---|---|---|
app_key | *Required | |
collection | *Required | |
filter | Option | |
projection | Option | |
num | Option |
API Response
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
Result | Array | MongoDB结果,成功时返回文档数据列表,失败时返回Null |
HTTP Response Code
HTTP Status Code | Description |
---|---|
Http Status = 200 | Success |
Http Status = 400 | Illegal-Params |
Http Status = 401 | Illegal-Token |
Http Status = 402 | IP-Banned |
Http Status = 404 | API-NOT-Exsits |
Http Status = 406 | Illegal-APPKEY |
Http Status = 407 | APPKEY-Expired-Out |
Http Status = 408 | APPKEY-Busy |
Http Status = 409 | Illegal-Sign |
Http Status = 413 | API-Traffic-NOT-Enough |
Http Status = 415 | API-LOCKED |
Http Status = 500 | Internal-Server-Error |