获取机器详情

最近更新时间: 2026-09-17 00:02:49

1. 接口描述

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

本接口（DescribeMachineInfo）用于获取机器详细信息。

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

接口更新时间：2022-05-20 15:11:35。

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeMachineInfo
Version	是	否	String	公共参数，本接口取值：2018-02-28
Region	是	否	String	公共参数，地域信息本接口不需要传递此参数。
Quuid	否	否	String	Quuid , Uuid 必填一项示例值： e5b4724c-49af-46ab-bd84-cdbae897e7e0
Uuid	否	否	String	主机安全客户端唯一Uuid。示例值： e5b4724c-49af-46ab-bd84-cdbae897e7e0

3. 输出参数

参数名称	类型	描述
AgentVersion	String	agent版本号示例值： 10
FreeMalwaresLeft	Uint64	免费木马剩余检测数量。示例值： 1
FreeVulsLeft	Uint64	免费漏洞剩余检测数量。示例值： 1
HasAssetScan	Uint64	是否有资产扫描记录，0无，1有示例值： 1
InstanceId	String	CVM或BM主机唯一标识。示例值： CVM
IsProVersion	Bool	是否开通专业版。 true：是 false：否示例值： false
MachineIp	String	机器ip。示例值： 10.0.0.0
MachineName	String	主机名称。示例值： redis_node_cvm
MachineOs	String	操作系统。示例值： Windows Server 2022
MachineRegion	String	机器所属地域示例值： ap-region1
MachineStatus	String	在线状态。 ONLINE：在线 OFFLINE：离线示例值： OFFLINE
MachineType	String	云服务器类型。 CVM: 云服务器 BM: 黑石物理机 ECM: 边缘计算服务器 LH: 轻量应用服务器 Other: 混合云机器示例值： CVM
MachineWanIp	String	主机外网IP。示例值： 10.0.0.0
PayMode	String	主机状态。 POSTPAY: 表示后付费，即按量计费 PREPAY: 表示预付费，即包年包月示例值： PREPAY
ProVersionDeadline	String	专业版到期时间(仅预付费) 示例值： 2025-10-17 20:08:03
ProVersionOpenDate	String	专业版开通时间。示例值： 2024-10-17 20:08:03
ProtectDays	Uint64	受主机安全保护天数。示例值： 1
ProtectType	String	防护版本：BASIC_VERSION 基础版，PRO_VERSION 专业版，Flagship 旗舰版，GENERAL_DISCOUNT 普惠版示例值： BASIC_VERSION
Quuid	String	CVM或BM主机唯一Uuid。示例值： e5b4724c-49af-46ab-bd84-cdbae897e7e0
Uuid	String	主机安全客户端唯一Uuid。示例值： e5b4724c-49af-46ab-bd84-cdbae897e7e0
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码	描述
InternalError	内部错误。
InvalidParameter.ParsingError	参数解析错误。
InvalidParameter.MissingParameter	参数缺失。
InvalidParameter.InvalidFormat	参数格式错误。
ResourceNotFound	资源不存在。
InvalidParameterValue	参数取值错误。

5. 示例

示例1 获取机器详情

本接口（DescribeMachineInfo）用于获取机器详细情况。

输入示例

https://cwp.api3.fincloud.tencent.cn/?Action=DescribeMachineInfo
&Uuid=UUID
&<Public request parameters>

输出示例

{
    "Response": {
        "AgentVersion": "1.0.1",
        "FreeMalwaresLeft": 0,
        "FreeVulsLeft": 0,
        "HasAssetScan": 0,
        "InstanceId": "ins-ivkxaaaa",
        "IsProVersion": true,
        "MachineIp": "172.16.255.2",
        "MachineName": "tke_cls-kjg9r3fh_master_etcd1",
        "MachineOs": "TOSServer 3.1 (TK4)",
        "MachineRegion": "ap-city1",
        "MachineStatus": "ONLINE",
        "MachineType": "CVM",
        "MachineWanIp": "124.222.61.130",
        "PayMode": "PREPAY",
        "ProVersionDeadline": "2024-01-10 10:51:11",
        "ProVersionOpenDate": "2023-08-07 14:54:29",
        "ProtectDays": 98,
        "ProtectType": "Flagship",
        "Quuid": "a081a69d-aaaa-bbbb-b456-59f381de839b",
        "RequestId": "8564b09e-0e04-4516-bb59-db09742503c2",
        "Uuid": "a081a69d-aaaa-bbbb-b456-59f381de839b"
    }
}