获取机器状态

最近更新时间: 2026-09-17 00:06:37

1. 接口描述

接口请求域名： cls.api3.fincloud.tencent.cn。

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

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

接口更新时间：2025-02-26 05:22:00。

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeMachines
Version	是	否	String	公共参数，本接口取值：2020-10-16
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
GroupId	是	否	String	查询的机器组ID 示例值： ae0d14a7-94e1-461e-8f5d-7d66a0d56d35

3. 输出参数

参数名称	类型	描述
Machines	Array of MachineInfo	机器状态信息组示例值：查看
AutoUpdate	Int64	机器组是否开启自动升级功能。 0：未开启自动升级；1：开启了自动升级。示例值： 0
UpdateStartTime	String	机器组自动升级功能预设开始时间示例值： 00:00:00
UpdateEndTime	String	机器组自动升级功能预设结束时间示例值： 01:00:00
LatestAgentVersion	String	当前用户可用最新的Loglistener版本示例值： 2.2.0
ServiceLogging	Bool	是否开启服务日志。true表示开启服务日志，false表示不开启服务日志。示例值： true
Flag	String	TKE标志位，默认值为空字符串。空字符串表示日志不是来自于TKE，label_k8s表示日志来自于TKE。示例值： label_k8s
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码	描述
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
MissingParameter	缺少参数错误。
InternalError	内部错误。
FailedOperation	操作失败。
AuthFailure	CAM签名/鉴权错误。
OperationDenied	操作被拒绝。
ResourceNotFound.MachineGroupNotExist	机器组不存在。
ResourceNotFound.AgentVersionNotExist	agent version不存在。
OperationDenied.AccountIsolate	账户欠费。
OperationDenied.AccountDestroy	账户已销毁。
OperationDenied.AccountNotExists	账户不存在。

5. 示例

示例1 获取机器状态

输入示例

POST / HTTP/1.1
Host: cls.api.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"
    }
}