1. 接口描述
接口请求域名: dasb.tencentcloudapi.com 。
搜索文件传输会话下文件操作列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:SearchFileBySid。 |
Version | 是 | String | 公共参数,本接口取值:2019-10-18。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Sid | 是 | String | 若入参为Id,则其他入参字段不作为搜索依据,仅按照Id来搜索会话 示例值:dfac9070-8b23-499e-83b2-a50e3 |
AuditLog | 是 | Boolean | 是否创建审计日志,通过查看按钮调用时为true,其他为false 示例值:true |
Limit | 否 | Integer | 分页的页内记录数,默认为20,最大200 示例值:10 |
FileName | 否 | String | 可填写路径名或文件名 示例值:1.txt |
Offset | 否 | Integer | 分页用偏移量 示例值:123 |
AuditAction | 否 | Integer | 1-已执行, 2-被阻断 示例值:1 |
TypeFilters.N | 否 | Array of SearchFileTypeFilter | 以Protocol和Method为条件查询 示例值:[{"Protocol":"SFTP","Method":[1,2]}] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 记录数 示例值:20 |
SearchFileBySidResult | Array of SearchFileBySidResult | 某会话的文件操作列表 示例值: [ { "Time": "2020-01-02T01:01:01+08:00", "Method": 1, "Protocol": "SFTP", "FileCurr": "/home/1.txt", "FileNew": "/home/2.txt", "Action": 1, "Size": 1024 } ] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 搜索session列表
搜索session列表
输入示例
POST / HTTP/1.1
Host: dasb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SearchFileBySid
<公共请求参数>
{
"FileName": "1.txt",
"Offset": 1,
"Sid": "dfac9070-8b23-499e-83b2-a50e3ca",
"Limit": 5,
"AuditLog": true
}
输出示例
{
"Response": {
"TotalCount": 10,
"RequestId": "dfac9070-8b23-499e-83b2-a50e3ca059af",
"SearchFileBySidResult": [
{
"Time": "2020-01-02T01:01:01+08:00",
"Method": 1,
"Protocol": "SFTP",
"FileCurr": "/home/1.txt",
"FileNew": "/home/2.txt",
"Action": 1,
"Size": 1024
}
]
}
}
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 | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |