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

1. 接口描述

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

获取指定机器组下的机器状态

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeMachines。
Version	是	String	公共参数，本接口取值：2020-10-16。
Region	是	String	公共参数，详见产品支持的地域列表。
GroupId	是	String	查询的机器组ID 示例值：ae0d14a7-94e1-461e-8f5d-7d66a0d56d35
Filters.N	否	Array of Filter	ip - 按照【ip】进行过滤。 - 类型：String - 必选：否 instance - 按照【instance】进行过滤。 - 类型：String - 必选：否 version - 按照【LogListener版本】进行过滤。 - 类型：String - 必选：否 status - 按照【状态】进行过滤。 - 类型：String - 必选：否 - 可选值：0：离线，1：正常 offlineTime - 按照【机器离线时间】进行过滤。 - 类型：String - 必选：否 - - 可选值：0：无离线时间，12：12小时内，24：一天内，48：两天内，99：两天前每次请求的Filters的上限为10，Filter.Values的上限为100。
Offset	否	Integer	分页的偏移量。示例值：0
Limit	否	Integer	分页单页限制数目。最大支持100 示例值：10

3. 输出参数

参数名称	类型	描述
Machines	Array of MachineInfo	机器状态信息组
AutoUpdate	Integer	机器组是否开启自动升级功能。 0：未开启自动升级；1：开启了自动升级。示例值：0
UpdateStartTime	String	机器组自动升级功能预设开始时间示例值：00:00:00
UpdateEndTime	String	机器组自动升级功能预设结束时间示例值：01:00:00
LatestAgentVersion	String	当前用户可用最新的Loglistener版本示例值：2.2.0
ServiceLogging	Boolean	是否开启服务日志示例值：true
TotalCount	Integer	总数目注意：此字段可能返回 null，表示取不到有效值。示例值：2
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取机器状态

输入示例

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

{
    "GroupId": "57f5808c-4a55-11eb-b378-0242ac130002"
}

输出示例

{
    "Response": {
        "Machines": [
            {
                "Ip": "10.10.10.10",
                "Status": 0,
                "Version": "2.1.0",
                "UpdateStatus": 0,
                "ErrCode": 0,
                "ErrMsg": "OK",
                "AutoUpdate": 1,
                "OfflineTime": "2020-12-18 11:17:28"
            }
        ],
        "AutoUpdate": 0,
        "UpdateStartTime": "00:00:00",
        "UpdateEndTime": "01:00:00",
        "LatestAgentVersion": "2.2.0",
        "ServiceLogging": true,
        "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
    }
}

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	操作失败。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
MissingParameter	缺少参数错误。
OperationDenied	操作被拒绝。
OperationDenied.AccountDestroy	账户已销毁。
OperationDenied.AccountIsolate	账户欠费。
OperationDenied.AccountNotExists	账户不存在。
ResourceNotFound.AgentVersionNotExist	agent version不存在。
ResourceNotFound.MachineGroupNotExist	机器组不存在。

获取机器状态

本页目录：