日志服务获取机器组列表-机器组相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： cls.tencentcloudapi.com 。

获取机器组信息列表

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

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeMachineGroups。
Version	是	String	公共参数，本接口取值：2020-10-16。
Region	是	String	公共参数，详见产品支持的地域列表。
Filters.N	否	Array of Filter	machineGroupName - 按照【机器组名称】进行过滤。 - 类型：String - 必选：否 machineGroupId - 按照【机器组ID】进行过滤。 - 类型：String - 必选：否 osType - 按照【操作系统类型】进行过滤。 - 类型：Int - 必选：否 tagKey - 按照【标签键】进行过滤。 - 类型：String - 必选：否 tag:tagKey - 按照【标签键值对】进行过滤。tagKey使用具体的标签键进行替换。 - 类型：String - 必选：否每次请求的Filters的上限为10，Filter.Values的上限为5。
Offset	否	Integer	分页的偏移量，默认值为0 示例值：0
Limit	否	Integer	分页单页的限制数目，默认值为20，最大值100 示例值：10

3. 输出参数

参数名称	类型	描述
MachineGroups	Array of MachineGroupInfo	机器组信息列表注意：此字段可能返回 null，表示取不到有效值。
TotalCount	Integer	分页的总数目示例值：10
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取机器组列表

获取包含指定标签的机器组列表

输入示例

POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMachineGroups
<公共请求参数>

{
    "Filters": [
        {
            "Key": "tagKey",
            "Values": [
                "k1"
            ]
        }
    ],
    "Offset": 0,
    "Limit": 10
}

输出示例

{
    "Response": {
        "MachineGroups": [
            {
                "GroupId": "4a4ee397-xxxx-466f-a04c-b3413b9db40c",
                "GroupName": "cos-recharge",
                "MachineGroupType": {
                    "Type": "label",
                    "Values": [
                        "cos-recharge"
                    ]
                },
                "CreateTime": "2022-02-13 21:07:54",
                "AutoUpdate": "",
                "UpdateStartTime": "",
                "UpdateEndTime": "",
                "ServiceLogging": true,
                "DelayCleanupTime": 30,
                "MetaTags": [],
                "Tags": []
            }
        ],
        "TotalCount": 1,
        "RequestId": "2dc17eaa-xxxx-40ea-8cdc-650aa85ccb80"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
FailedOperation	操作失败。
FailedOperation.TagQpsLimit	请求标签服务限频。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
OperationDenied	操作被拒绝。
OperationDenied.AccountDestroy	账户已销毁。
OperationDenied.AccountIsolate	账户欠费。
OperationDenied.AccountNotExists	账户不存在。
UnsupportedOperation	操作不支持。

获取机器组列表

本页目录：