提交文件检测任务后,您可以调用/green/file/results接口查询文件检测结果。
使用说明
业务接口:/green/file/results,表示查询文件检测结果。
客户端定时轮询检测结果。建议您将查询间隔设置为30秒,最长不能超过1个小时,否则结果将会丢失。
QPS限制
本接口的单用户QPS限制为50次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
body | StringArray | 是 | ["file_t_6Tu1kOFV4Lw4g7dWMH4Yp1-1oB8Ci","file_image_t_5pvbNDryAe06MsUTytddIY-1oC1Db"] | 要查询的检测任务的taskId列表。数组中的元素个数不超过100个。
您在提交检测任务后,可以从返回数据中获取检测任务的taskId。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Integer | 200 | 错误码,和HTTP状态码一致。
更多信息,请参见公共错误码。 |
taskId | String | file_t_6Tu1kOFV4Lw4g7dWMH4Yp1-1oB8Ci | 检测任务的ID。 |
dataId | String | test6WVsaaxBAkY5wWn4N6kCU$-1oB8Ci | 检测对象对应的数据ID。
说明 如果在检测请求参数中传入了dataId,则此处返回对应的dataId。
|
textResults | JSONArray | 传入textScenes时的文本扫描结果。关于具体结果描述,请参见文本审核中的返回参数部分。 | |
imageResults | JSONArray | 传入imageScenes时的图片扫描结果。关于具体结构描述,请参见图片审核结果查询中的返回参数部分。 | |
url | String | https://aliyundoc.com/test/file/test3.docx?Expires=1521800184&OSSAccessKeyId=xxxxxxxxxxx&Signature=xxxxxxxxxxxx | 被检测源文件的链接。 |
msg | String | OK | 请求参数的响应信息。 |
示例
请求示例
http(s)://[Endpoint]/green/file/results
&<公共请求参数>
[
"file_t_6Tu1kOFV4Lw4g7dWMH4Yp1-1oB8Ci",
"file_image_t_5pvbNDryAe06MsUTytddIY-1oC1Db"
]
正常返回示例
{
"code": 200,
"data": [
{
"dataId": "test6WVsaaxBAkY5wWn4N6kCU$-1oB8Ci",
"taskId": "file_t_6Tu1kOFV4Lw4g7dWMH4Yp1-1oB8Ci",
"textResults": [
{
"code": 200,
"content": "test",
"msg": "OK",
"results": [
{
"label": "normal",
"rate": 99.91,
"scene": "antispam",
"suggestion": "pass"
}
],
"taskId": "file_text_t_5R3Pmeqkbl94kSNl5uvTKN-1oB8Cl"
}
],
"imageResults": [
{
"msg": "OK",
"code": 200,
"results": [
{
"rate": 99.91,
"suggestion": "pass",
"label": "normal",
"scene": "terrorism"
},
{
"rate": 99.91,
"suggestion": "pass",
"label": "normal",
"scene": "porn"
}
],
"taskId": "file_image_t_5pvbNDryAe06MsUTytddIY-1oC1Db",
"url": "http://aliyundoc.com/prod/hammal/2611c68/6_10188943_5inaGVFwoCSh3ii3pdjhAOWahE76XSySjmErLYhy_analysis_file.png?Expires=1522039397&OSSAccessKeyId=xxxxxxxx&Signature=xxxxxxxxxxxxxxxx"
}
],
"url": "https://aliyundoc.com/test/file/test3.docx?Expires=1521800184&OSSAccessKeyId=xxxxxxxxxxx&Signature=xxxxxxxxxxxx"
}
],
"msg": "OK",
"requestId": "68C7BA1A-3F91-454A-A1B7-81CA032348F3"
}