DescribeMachines
最近更新时间: 2025-10-20 17:05:57
1. 接口描述
接口请求域名： cls.api3.fincloud.tencent.cn。
获取制定机器组下的机器状态
默认接口请求频率限制：20次/秒。
接口更新时间：2022-10-31 11:10:35。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeMachines |
| Version | 是 | 否 | String | 公共参数，本接口取值：2020-10-16 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| GroupId | 是 | 否 | String | 查询的机器组ID |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Machines | MachineInfo | 此参数对外不可见。 机器状态信息组 |
| AutoUpdate | Int64 | 此参数对外不可见。 机器组是否开启自动升级功能 |
| UpdateStartTime | String | 此参数对外不可见。 机器组自动升级功能预设开始时间 |
| UpdateEndTime | String | 此参数对外不可见。 机器组自动升级功能预设结束时间 |
| LatestAgentVersion | String | 此参数对外不可见。 当前用户可用最新的Loglistener版本 |
| ServiceLogging | Bool | 此参数对外不可见。 是否开启服务日志 |
| Flag | String | 此参数对外不可见。 默认值""，"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 | 账户不存在。 |