1. 接口描述
接口请求域名： cls.tencentcloudapi.com 。
获取采集规则配置所绑定的机器组
默认接口请求频率限制：1000次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeConfigMachineGroups。 |
| Version | 是 | String | 公共参数，本接口取值：2020-10-16。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ConfigId | 是 | String | 采集配置ID 示例值：xxxxxxxxxx |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| MachineGroups | Array of MachineGroupInfo | 采集规则配置绑定的机器组列表 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取采集规则配置所绑定的机器组
获取采集规则配置所绑定的机器组
输入示例
POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeConfigMachineGroups
<公共请求参数>
{
"ConfigId": "xxxxxxxxxx"
}输出示例
{
"Response": {
"MachineGroups": [
{
"AutoUpdate": "",
"CreateTime": "2023-11-24 10:22:58",
"DelayCleanupTime": 0,
"GroupId": "59613f03-304e-492d-8bcc-af04716f4111",
"GroupName": "test-filter",
"MachineGroupType": {
"Type": "ip",
"Values": [
"9.1.9.1"
]
},
"MetaTags": [],
"OSType": 0,
"ServiceLogging": false,
"Tags": [],
"UpdateEndTime": "",
"UpdateStartTime": ""
}
],
"RequestId": "f32611a9-c1ff-48f3-97b3-32e28fe5b359"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.AccountDestroy | 账户已销毁。 |
| OperationDenied.AccountIsolate | 账户欠费。 |
| OperationDenied.AccountNotExists | 账户不存在。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.ConfigNotExist | 指定的采集规则配置不存在。 |