1. 接口描述
接口请求域名: bhsaas.api3.fincloud.tencent.com。
搜索文件传输会话下文件操作列表
默认接口请求频率限制:20次/秒。
接口更新时间:2023-09-05 03:35:40。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:SearchFileBySid |
| Version | 是 | 否 | String | 公共参数,本接口取值:2019-10-18 |
| Region | 是 | 否 | String | 公共参数,地域信息本接口不需要传递此参数。 |
| Limit | 否 | 否 | Uint64 | 分页的页内记录数,默认为20,最大200 示例值: 10 |
| Sid | 是 | 否 | String | 若入参为Id,则其他入参字段不作为搜索依据,仅按照Id来搜索会话 示例值: bh-test-sid-1a2b3c |
| FileName | 否 | 否 | String | 可填写路径名或文件名 示例值: 1.txt |
| Offset | 否 | 否 | Uint64 | 分页用偏移量 示例值: 0 |
| AuditLog | 是 | 否 | Bool | 是否创建审计日志,通过查看按钮调用时为true,其他为false 示例值: true |
| AuditAction | 否 | 否 | Int64 | 1-已执行, 2-被阻断 示例值: 1 |
| TypeFilters | 否 | 否 | Array of SearchFileTypeFilter | 以Protocol和Method为条件查询 示例值:查看 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Uint64 | 记录数 示例值: 20 |
| SearchFileBySidResult | Array of SearchFileBySidResult | 某会话的文件操作列表 示例值:查看 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| InternalError | 内部错误。 |
| InvalidParameterValue | 参数取值错误。 |