主机安全获取机器详情-API 文档-文档中心-腾讯云

1. 接口描述

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

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

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeMachineInfo。
Version	是	String	公共参数，本接口取值：2018-02-28。
Region	否	String	公共参数，此参数为可选参数。
Uuid	否	String	主机安全客户端唯一Uuid。示例值：e5b4724c-49af-46ab-bd84-cdbae897e7e0
Quuid	否	String	Quuid , Uuid 必填一项示例值：e5b4724c-49af-46ab-bd84-cdbae897e7e0

3. 输出参数

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

4. 示例

示例1 获取机器详情

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

输入示例

https://cwp.tencentcloudapi.com/?Action=DescribeMachineInfo
&Uuid=UUID
&<公共请求参数>

输出示例

{
    "Response": {
        "AgentVersion": "",
        "FreeMalwaresLeft": 0,
        "FreeVulsLeft": 0,
        "HasAssetScan": 0,
        "InstanceId": "ins-ivkxaaaa",
        "IsProVersion": true,
        "MachineIp": "172.16.255.2",
        "MachineName": "tke_cls-kjg9r3fh_master_etcd1",
        "MachineOs": "TencentOS Server 3.1 (TK4)",
        "MachineRegion": "ap-shanghai",
        "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"
    }
}

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. 错误码

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

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

获取机器详情

本页目录：