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 | 是否开通专业版。 示例值: false |
| MachineIp | String | 机器ip。 示例值: 10.0.0.0 |
| MachineName | String | 主机名称。 示例值: redis_node_cvm |
| MachineOs | String | 操作系统。 示例值: Windows Server 2022 |
| MachineRegion | String | 机器所属地域 示例值: ap-region1 |
| MachineStatus | String | 在线状态。 示例值: OFFLINE |
| MachineType | String | 云服务器类型。 示例值: CVM |
| MachineWanIp | String | 主机外网IP。 示例值: 10.0.0.0 |
| PayMode | String | 主机状态。 示例值: 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 | 参数取值错误。 |