获取机器详情
最近更新时间: 2024-09-03 18:50:07
1. 接口描述
接口请求域名： cwp.api3.cloud.sunhongs.com。
本接口（DescribeMachineInfo）用于获取机器详细信息。
默认接口请求频率限制：20次/秒。
接口更新时间：2022-05-20 15:11:35。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeMachineInfo |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-02-28 |
| Region | 是 | 否 | String | 公共参数，本接口不需要传递此参数。 |
| Quuid | 否 | 否 | String | Quuid , Uuid 必填一项 |
| Uuid | 否 | 否 | String | 云镜客户端唯一Uuid。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| AgentVersion | String | agent版本号 |
| FreeMalwaresLeft | Uint64 | 免费木马剩余检测数量。 |
| FreeVulsLeft | Uint64 | 免费漏洞剩余检测数量。 |
| HasAssetScan | Uint64 | 是否有资产扫描记录，0无，1有 |
| InstanceId | String | CVM或BM主机唯一标识。 |
| IsProVersion | Bool | 是否开通专业版。<br><li>true：是</li><br><li>false：否</li> |
| MachineIp | String | 机器ip。 |
| MachineName | String | 主机名称。 |
| MachineOs | String | 操作系统。 |
| MachineRegion | String | 机器所属地域。如：ap-guangzhou，ap-shanghai |
| MachineStatus | String | 在线状态。<br><li>ONLINE： 在线</li><br><li>OFFLINE：离线</li> |
| MachineType | String | 云服务器类型。<br><li>CVM: 腾讯云服务器</li><br><li>BM: 黑石物理机</li><br><li>ECM: 边缘计算服务器</li><br><li>LH: 轻量应用服务器</li><br><li>Other: 混合云机器</li> |
| MachineWanIp | String | 主机外网IP。 |
| PayMode | String | 主机状态。<br><li>POSTPAY: 表示后付费，即按量计费 </li><br><li>PREPAY: 表示预付费，即包年包月</li> |
| ProVersionDeadline | String | 专业版到期时间(仅预付费) |
| ProVersionOpenDate | String | 专业版开通时间。 |
| ProtectDays | Uint64 | 受云镜保护天数。 |
| ProtectType | String | 防护版本 BASIC_VERSION 基础版, PRO_VERSION 专业版 Flagship 旗舰版. |
| Quuid | String | CVM或BM主机唯一Uuid。 |
| Uuid | String | 云镜客户端唯一Uuid。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | |
| InvalidParameter.ParsingError | |
| InvalidParameter.MissingParameter | |
| InvalidParameter.InvalidFormat | |
| ResourceNotFound | |
| InvalidParameterValue |