功能描述
本接口用于查询一个病毒检测任务的状态或结果。
请求
请求示例
GET /virus/detect/<jobId> HTTP/1.1
Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
说明:
请求头
此接口仅使用公共请求头部,详情请参见 公共请求头部 文档。
请求体
该请求无请求体。
响应
响应头
此接口仅返回公共响应头部,详情请参见 公共响应头部 文档。
响应体
该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:
<Response>
<JobsDetail>
<Code></Code>
<Message></Message>
<JobId></JobId>
<State></State>
<CreationTime></CreationTime>
<Object></Object>
<Suggestion></Suggestion>
<DetectDetail>
<Result>
<FileName></FileName>
<VirusName></VirusName>
</Result>
<Result>
<FileName></FileName>
<VirusName></VirusName>
</Result>
</DetectDetail>
</JobsDetail>
<RequestId></RequestId>
</Response>
具体的数据内容如下:
节点名称(关键字) | 父节点 | 描述 | 类型 |
---|---|---|---|
Response | 无 | 病毒检测任务结果。 | Container |
Container 节点 Response 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
---|---|---|---|
JobsDetail | Response | 病毒检测任务的详细信息。 | Container |
Container 节点 JobsDetail 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
---|---|---|---|
Code | Response.JobsDetail | 错误码,只有 State 为 Failed 时有意义。 | String |
Message | Response.JobsDetail | 错误描述,只有 State 为 Failed 时有意义。 | String |
JobId | Response.JobsDetail | 本次病毒检测任务的 ID。 | String |
State | Response.JobsDetail | 病毒检测任务的状态,值为 Submitted(已提交检测)、Success(检测成功)、Failed(检测失败)、Auditing(检测中)其中一个。 | String |
CreationTime | Response.JobsDetail | 病毒检测任务的创建时间。 | String |
Object | Response.JobsDetail | 检测的文件为存储在 COS 中的文件时,该字段表示本次检测的文件名称。 | String |
Url | Response.JobsDetail | 检测的文件为一条文件链接时,该字段表示本次检测的文件链接。 | String |
Suggestion | Response.JobsDetail | 该字段表示本次判定的检测结果,您可以根据该结果,进行后续的操作;建议您按照业务所需,对不同的检测结果进行相应处理。有效值:nomal(检测正常),block (检测到文件含有病毒)。 | String |
DetectDetail | Response.JobsDetail | 本次检测的详细信息。 | Container Array |
Container 节点 DetectDetail 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
---|---|---|---|
Result | Response.JobsDetail.DetectDetail | 单个文件的检测结果,可能有多个结果。 | Array |
Array 节点 Result 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
---|---|---|---|
FileName | Response.JobsDetail.DetectDetail.Result | 检测的文件名称,如果是压缩文件,该字段表示解压后内部的具体文件名。 | String |
VirusName | Response.JobsDetail.DetectDetail.Result | 检测到的病毒名称。 | String |
错误码
该请求操作无特殊错误信息,常见的错误信息请参见 错误码 文档。
实际案例
请求
GET /virus/detect/ssb1ca9fc8a3ed11ea834c525400863904 HTTP/1.1
Accept: */*
Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0e****
Host: examplebucket-1250000000.ci.ap-beijing.myqcloud.com
响应
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 666
Connection: keep-alive
Date: Thu, 15 Jun 2017 12:37:29 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****
<Response>
<JobsDetail>
<Code>Success</Code>
<Message>Success</Message>
<JobId>ss364c726b370211ec8fb35254008618d9</JobId>
<State>Success</State>
<CreationTime>2021-07-07T12:12:12+0800</CreationTime>
<Object>a.doc</Object>
<Suggestion>block</Suggestion>
<DetectDetail>
<Result>
<FileName>xxx</FileName>
<VirusName>Bk.YDWebShell.Php.Small.11100752</VirusName>
</Result>
<Result>
<FileName>xxx</FileName>
<VirusName>Bk.YDWebShell.Php.Small.11100752</VirusName>
</Result>
</DetectDetail>
</JobsDetail>
</Response>