1. 接口描述
接口请求域名: csip.tencentcloudapi.com 。
获取客户端运行模式和运行配置信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeAgentRunMode。 |
| Version | 是 | String | 公共参数,本接口取值:2022-11-21。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| MemberId.N | 否 | Array of String | 集团账号的成员id 示例值:["mem-tencent-e74488e0ba0cd8fe"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| CustomPolicy | CustomAgentRunModePolicy | 自定义模式配置 |
| AdvanceModeQuuids | Array of String | 高安全防护模式quuid列表 示例值:["32ae29f6-03e6-4faa-962a-5d0a9be33c2d"] |
| CustomModeQuuids | Array of String | 自定义模式quuid列表 示例值:["829fdf0d-b8d8-431e-9f96-ed54a143edff"] |
| EnhanceLogMode | Integer | 日志增强开关,0:关闭,1:打开 示例值:1 |
| MalwarePocMode | Integer | 文件查杀自动poc模式开关,0:关闭,1:打开 示例值:1 |
| ReportSourcePort | Integer | 五元组日志是否上报源端口,0:不上报,1:上报 示例值:1 |
| BasicPolicy | CustomAgentRunModePolicy | 业务优先配置 |
| AdvancePolicy | CustomAgentRunModePolicy | 安全优先配置 |
| LogCollectSettings | Array of String | 日志采集设置,采集TCP源端口tcp_src_port,TCP入向日志tcp_ingress,HTTP出向连接日志http_egress,HTTP入向连接日志http_ingress,应用访问日志app_access 示例值:["app_access"] |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查看用户客户端运行模式配置
查看用户客户端运行模式配置
输入示例
POST / HTTP/1.1
Host: cwp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAgentRunMode
<公共请求参数>
{}
输出示例
{
"Response": {
"AdvanceModeQuuids": [
"18d5ca9e-6880-43de-a4c5-d6e62fc6bb7b"
],
"AdvancePolicy": {
"Cpu": 30,
"Memory": 300,
"NetworkPps": 0
},
"BasicPolicy": {
"Cpu": 0,
"Memory": 200,
"NetworkPps": 0
},
"CustomModeQuuids": [
"0e595552-e57e-450d-989c-16e4d4e0a464"
],
"CustomPolicy": {
"Cpu": 30,
"Memory": 0,
"NetworkPps": 100000
},
"EnhanceLogMode": 1,
"MalwarePocMode": 0,
"ReportSourcePort": 0,
"RequestId": "1a4d4ed6-bd5d-4990-9190-e0c3bb1997ba"
}
}
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: 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
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。