1. 接口描述
接口请求域名: csip.tencentcloudapi.com 。
查询客户端配置设置(配置组),从DescribeAgentRunMode拆分出的独立接口
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeAgentConfigSetting。 |
| Version | 是 | String | 公共参数,本接口取值:2022-11-21。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| MemberId.N | 否 | Array of String | 集团账号的成员id 示例值:["mem-tencent-b624e485fee5fe29"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| EnhanceLogMode | Integer | 增强日志模式开关,0-关闭 1-开启(未配置时为空) 示例值:1 |
| MalwarePocMode | Integer | 恶意软件 POC 模式开关,0-关闭 1-开启(未配置时为空) 示例值:0 |
| ReportSourcePort | Integer | 上报源端口开关(兼容旧版本),0-关闭 1-开启 示例值:0 |
| LogCollectSettings | Array of String | 已开启的日志采集类型列表,如 tcp_ingress、tcp_src_port、http_egress、http_ingress、app_access 示例值:["tcp_ingress"] |
| AssetSelectionType | String | 资产选择方式:all/tag/direct 示例值:direct |
| TagIds | Array of String | 按标签选择时的标签ID数组 示例值:["1"] |
| InstanceIDs | Array of String | 直接选择的主机instance_id列表 示例值:["ins-q4pf14qs"] |
| ExcludeInstanceIDs | Array of String | 排除的主机instance_id列表 示例值:["ins-q4pf14qs"] |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAgentConfigSetting
<公共请求参数>
{
"MemberId": [
"mem-tencent-b624e485fee5fe29"
]
}
输出示例
{
"Response": {
"AssetSelectionType": "direct",
"EnhanceLogMode": 0,
"ExcludeInstanceIDs": [],
"InstanceIDs": [
"ins-q4pf14qs"
],
"LogCollectSettings": [
"tcp_ingress"
],
"MalwarePocMode": 0,
"ReportSourcePort": 0,
"TagIds": [],
"RequestId": "82adab1d-9b89-4620-97f5-288d69e1bdaa"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| ResourceNotFound | 资源不存在。 |