运维安全中心 风险事件

一、1. 接口描述

搜索文件传输会话下文件操作列表

默认接口请求频率限制：20次/秒。

二、2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：SearchFileBySid。
Version	是	String	公共参数，本接口取值：2023-04-18。
Region	是	String	公共参数，详见产品支持的地域列表。
Sid	是	String	若入参为Id，则其他入参字段不作为搜索依据，仅按照Id来搜索会话示例值：bh-test-sid-1a2b3c
AuditLog	是	Boolean	是否创建审计日志,通过查看按钮调用时为true,其他为false示例值：true
Limit	否	Integer	分页的页内记录数，默认为20，最大200示例值：10
FileName	否	String	可填写路径名或文件名示例值：1.txt
Offset	否	Integer	分页用偏移量示例值：0
AuditAction	否	Integer	1-已执行， 2-被阻断示例值：1
AuditActionSet.N	否	Array of Integer	1-已执行， 2-被阻断示例值：[1,2]
TypeFilters.N	否	Array of SearchFileTypeFilter	以Protocol和Method为条件查询

三、3. 输出参数

参数名称	类型	描述
TotalCount	Integer	记录数示例值：20
SearchFileBySidResult	Array of SearchFileBySidResult	某会话的文件操作列表
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

四、示例1 搜索session列表

搜索session列表

五、输入示例

POST / HTTP/1.1
Host: bh.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SearchFileBySid
<公共请求参数>
{
"FileName": "1.txt",
"Offset": 1,
"Sid": "bh-test-sid-1a2b3c",
"Limit": 5,
"AuditLog": true
}

六、输出示例

{
"Response": {
"TotalCount": 10,
"RequestId": "b8ebf0b3-ecf5-49bf-9f9d-86341c4072f1",
"SearchFileBySidResult": [
{
"Time": "2020-01-02T01:01:01Z",
"Method": 1,
"Size": 100,
"Action": 1,
"Protocol": "SFTP",
"FileCurr": "/home/1.txt",
"FileNew": "/home/2.txt"
}
]
}
}

七、腾讯云 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: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

十、命令行工具

·Tencent Cloud CLI 3.0

十一、6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。