响应状态码和Msg说明
调用成功或部分成功
| Response Code | Verbose Msg | 描述 | 排查建议 | 适用接口 |
|---|---|---|---|---|
| 0 | OK | 成功 | - | 全部 |
| 1 | OK，Beyond Limitation from {IP/Domain} | 部分成功，从某个IP或域名起超出请求次数限制。 | 批量查询限制分为两种：
| IP信誉 失陷检测 |
| 1 | OK，Invalid data format：{IP/Domain/vuln_id} | 部分成功，某些IP或域名或漏洞编号由于格式错误查询无效 | 批量查询时，请注意检查IP或域名或漏洞编号的格式。格式错误无法查询，符合格式要求的结果正常返回 | 漏洞情报 IP信誉 失陷检测 |
| 1 | OK，Invalid data format：{IP/Domain} and Beyond Limitation from {IP/Domain} | 部分成功，某些IP或域名由于格式错误查询无效，且从某个IP或域名起超出请求次数限制 | 批量查询时，同时出现格式错误和超出查询限制的提示，处理方式同上 | IP信誉 失陷检测 |
没有结果或暂未获得结果
| Response Code | Verbose Msg | 描述 | 排查建议 | 适用接口 |
|---|---|---|---|---|
| 2 | No Data | 没有数据 | 查询成功。查询的资源没有相关数据。 | 全部 |
| 3 | In Progress | 任务进行中 | 报告正在生成中，请稍后查询。 | 文件信誉报告 URL信誉报告 |
| 4 | No Report Found | 未发现报告 | 请通过提交文件分析接口，重新提交文件并分析，再获取分析结果。 | 文件信誉报告 URL信誉报告 |
| 5 | No MultiEngines Data | 没有反病毒扫描引擎检测数据。 | 请通过提交文件分析接口，重新提交文件并分析，再获取分析结果。 | 文件反病毒引擎检测报告 |
| 6 | URL Download Fail | URL 下载文件失败 | 下载文件超时，请您重新提交扫描URL请求。 | URL信誉报告 |
| 7 | URL Downloading | URL 下载文件中 | 文件下载中，请稍等。一段时间内如仍无返回，请联系微步在线工作人员。 | URL信誉报告 |
调用失败
| Response Code | Verbose Msg | 描述 | 排查建议 | 适用接口 |
|---|---|---|---|---|
| -1 | Invalid Account Status | 账户状态无效 | 您使用的API所属账户目前状态为无效。请联系微步在线工作人员。 | 全部 |
| Invalid Access IP | 无效的访问IP：{实际访问IP} | 微步在线云API有访问IP白名单限制，请查看"我的KEY"中已绑定的IP与当前请求使用的IP是否一致。 | ||
| Invalid API Key | 无效的API key | 请输入正确的APIKey。 您的APIKey可通过"我的KEY"查看 | ||
| Invalid Key Status | API key状态无效 | 您当前使用的APIKey被禁用。请联系微步在线工作人员。 | ||
| Invalid Parameter：{parameter} | 无效的API接口参数：{参数名} | 请确认输入的参数与接口说明文档中当前调用接口的请求参数要求是否一致。 | ||
| No Access to API Method | 没有访问接口权限 | 请查看"API权限"中您当前调用的API接口授权状态。 | ||
| Expired API Key | API Key过期 | API权限已经到期，如需继续使用，请联络您的微步在线产品对接人。 | ||
| -1 | Empty File | 上传空文件 | 您上传并分析了空文件，请确认是否选择了错误的文件上传。 | 提交文件分析 |
| -1 | File Size Too Large | 上传文件过大 | 上传的文件大小，请不要超过100M。 | 提交文件分析 |
| -1 | File Name Too Long | 上传文件名过长 | 上传的文件名，请不要超过128字节。 | 提交文件分析 |
| -1 | NO_AUTHORITY | 隐私样本，无法返回报告信息 | 建议将该样本进行上传，以获取报告信息。 | 文件信誉报告、文件反病毒引擎检测报告 |
| -1 | Invalid Cursor | 无效的Cursor | Cursor失效原因：
| 文件Hunting查询 |
| -2 | Invalid API Method | 无效的API接口 | 您调用的API接口不存在。请确认您调用的API接口是否在API接口说明文档提供的接口范围内。 | 全部 |
| -3 | Required:{resource/apikey/file/hash/url} | 接口请求参数必须项缺失：缺失的具体项。 | 请根据调用的接口，核对是否填写了全部的必要参数。 | |
| -4 | Frequent Limitation | 触发访问频次限制 | 您当前的请求已经超过了接口每分钟的默认限速频率。 请查看"API权限"中查询各接口的每分钟默认请求频率限制。 | |
| -4 | BeyondLimitation | 超出访问限制 | 您当前调用的接口已经超出接口授权限制。 请查看"API权限"中查询各接口的授权情况。 | |
| -5 | System Error | 系统错误 | 请联系您的微步在线产品对接人。 | |
| -6 | Model Error | 模型报错 | 请检查请求参数和格式是否正确，或稍后重试。如果问题持续，请联系微步在线工作人员。 | XGPT |
| -7 | Response Contains Restricted Content | 模型问题或回答包括敏感文本，拒绝回答 | 模型生成的内容被识别为包含受限信息，建议调整输入内容。 | |
| -8 | Query Not Relevant to Cybersecurity, Declined | 问题和网络安全无关，拒绝回答 | XGPT专注于网络安全相关内容，请确保您的请求与此领域相关。 | |
| -9 | Query Beyond Model Capabilities | 超出当前模型能力覆盖范围 | 您的请求内容超出模型的能力范围，请调整或简化问题，或向微步在线工作人员反馈此需求 | |
| -10 | Input Token Limit Exceeded | 请求tokens长度过长，超过模型限制 | 输入文本超出了模型可接受的最大Token长度，建议缩短输入文本，或将长文本分割成多次请求提交，以提高请求成功率。 | |
| -11 | Query Timeout | 查询返回超时 | 稍后重试查询，或者缩小查询范围重试查询 |
云API是北京微步在线科技有限公司旗下产品了解微步在线《用户服务条款》《数据保护政策》
联系我们：api@threatbook.cn
联系我们：api@threatbook.cnCopyright © ThreatBook.CN All Rights Reserved. 京ICP备15044984号-4 北京微步在线科技有限公司 京公网安备11010802025715号