1. 接口描述
接口请求域名: ioa.tencentcloudapi.com 。
webservice查询文件检测结果
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeDLPFileDetectResult。 |
Version | 是 | String | 公共参数,本接口取值:2022-06-01。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
DomainInstanceId | 否 | String | 管理域实例ID,用于CAM管理域权限分配 示例值:1 |
QueryID | 否 | String | 查询ID,即提交送检任务接口(CreateDLPFileDetectionTask)返回的任务ID(DLPFileDetectionTaskID) 示例值:053a8fe1-150f-434c-b8e9-f1d7804ded1f |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | DescribeDLPFileDetectResultData | 查询任务结果 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 检测失败示例
查询检测结果,结果失败
输入示例
POST / HTTP/1.1
Host: ioa.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDLPFileDetectResult
<公共请求参数>
{
"QueryID": "207d7f0d-fe43-4483-a6bb-470321e60bbc"
}
输出示例
{
"Response": {
"Data": {
"FileMd5": "aabba408088b6aea1601fe6823cef111",
"FileName": "商务合同.docx",
"Status": "检测失败:detect failed: open /data/services/pcmgr_enterprise/data/tmp/dlp_file/aabba408088b6aea1601fe6823cef111/%E5%95%86%E5%8A%A1%E5%90%88%E5%90%8C.docx: no such file or directory"
},
"RequestId": "778917dd-0258-4072-814a-10f62bb5d55b"
}
}
示例2 检测成功示例
查询检测结果,结果成功
输入示例
POST / HTTP/1.1
Host: ioa.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDLPFileDetectResult
<公共请求参数>
{
"QueryID": "81f73e3b-f42e-4c15-8ef5-2ca670e9446b"
}
输出示例
{
"Response": {
"Data": {
"DetectResult": "{\"Path\":\"/data/services/pcmgr_enterprise/data/tmp/dlp_file/e8bcc9bb7ef5765cb7ce79831ede2039/YOGA%20BOOK%E7%94%A8%E6%88%B7%E6%8C%87%E5%8D%97.pdf\",\"Type\":\".pdf\",\"Size\":802831,\"State\":2,\"Md5\":\"e8bcc9bb7ef5765cb7ce79831ede2039\",\"Result\":{\"FileName\":\"YOGA%20BOOK%E7%94%A8%E6%88%B7%E6%8C%87%E5%8D%97.pdf\",\"FileContent\":\"{\\\"FileAbstract\\\":\\\"YOGA BOOK with Windows®\\\\n用户指南\\\\nLenovo YB1-X91F\\\\nLenovo YB1-X91L\\\\nLenovo YB1-X91X\\\\n \\\\n \\\\n \\\\n \\\\n \\\\n \\\\n \\\\n \\\\n \\\\n \\\\n \\\\n \\\\n \\\\n \\\\n \\\\n入门指南\\\\n在使用本用户指南及其支持的产品之\\\"}\",\"HitRuleId\":[\"364313\"],\"HitRuleCategoryId\":[\"29198\"],\"HitLevel\":[\"S2\"],\"HitRuleDesc\":\"364313(通讯信息)\",\"HitContent\":\"[{\\\"RuleId\\\":\\\"364313\\\",\\\"Hits\\\":[{\\\"LibraryId\\\":\\\"5148\\\",\\\"Attribute\\\":\\\"doc.Content\\\",\\\"String\\\":\\\"电话\\\",\\\"Content\\\":\\\" Internet \\\\u003e 移动电话。\\\\n2. 点按移动网络的名称。\\\\n\\\"},{\\\"LibraryId\\\":\\\"5347\\\",\\\"Attribute\\\":\\\"doc.Content\\\",\\\"String\\\":\\\"邮箱\\\",\\\"Content\\\":\\\"有电子邮件帐户,可直接登录到电子邮箱。如果没有,您需要创建一个电子邮\\\"},{\\\"LibraryId\\\":\\\"5305\\\",\\\"Attribute\\\":\\\"doc.Content\\\",\\\"String\\\":\\\"地址\\\",\\\"Content\\\":\\\"名称,输入连接名称、服务器名称或地址、用户名和密码,然后点按保存以连\\\"},{\\\"LibraryId\\\":\\\"45\\\",\\\"Attribute\\\":\\\"doc.Type\\\",\\\"String\\\":\\\".pdf\\\",\\\"Content\\\":\\\".pdf\\\"}]}]\"},\"EngineConfigVersion\":\"1744627119\"}",
"FileMd5": "e8bcc9bb7ef5765cb7ce79831ede2039",
"FileName": "YOGA BOOK用户指南.pdf",
"Status": "检测成功"
},
"RequestId": "5bc117a2-410a-42f9-98ea-e54b4f275f8c"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError.DatabaseException | 内部错误,数据库异常。 |
InternalError.Unknown | 内部未知错误。 |
InvalidParameter.RequestParam | 请求参数错误。 |
UnauthorizedOperation.PermissionDenied | 未授权的操作。 |