获取机器详情

最近更新时间:2018-12-07 20:46:25

1. 接口描述

接口请求域名: yunjing.tencentcloudapi.com 。

本接口(DescribeMachineInfo)用于获取机器详细信息。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeMachineInfo
Version String 公共参数,本接口取值:2018-02-28
Region String 公共参数,本接口不需要传递此参数。
Uuid String 云镜客户端唯一Uuid。

3. 输出参数

参数名称 类型 描述
MachineIp String 机器ip。
ProtectDays Integer 受云镜保护天数。
MachineOs String 操作系统。
MachineName String 主机名称。
MachineStatus String 在线状态。
  • ONLINE: 在线
  • OFFLINE:离线
  • InstanceId String CVM或BM主机唯一标识。
    MachineWanIp String 主机外网IP。
    Quuid String CVM或BM主机唯一Uuid。
    Uuid String 云镜客户端唯一Uuid。
    IsProVersion Boolean 是否开通专业版。
  • true:是
  • false:否
  • ProVersionOpenDate String 专业版开通时间。
    MachineType String 云主机类型。
  • CVM: 虚拟主机
  • BM: 黑石物理机
  • MachineRegion String 机器所属地域。如:ap-guangzhou,ap-shanghai
    PayMode String 主机状态。
  • POSTPAY: 表示后付费,即按量计费
  • PREPAY: 表示预付费,即包年包月
  • RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 获取机器详情

    输入示例

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

    输出示例

    {
      "Response": {
        "InstanceId": "ins-ibqb87x3",
        "IsProVersion": true,
        "MachineIp": "10.104.248.0",
        "MachineName": "开发机",
        "MachineOs": "3.10.0-327.36.3.el7.x86_64",
        "MachineRegion": "ap-guangzhou",
        "MachineStatus": "ONLINE",
        "MachineType": "CVM",
        "MachineWanIp": "130.111.77.111",
        "PayMode": "PREPAY",
        "ProVersionOpenDate": "2018-07-30 12:34:22",
        "ProtectDays": 120,
        "Quuid": "56af8eea-5a2a-4f0c-81ca-47208e7cd9b2",
        "RequestId": "ad31cc35-8523-42a2-93e0-b733ad247daa",
        "Uuid": "e3fcbf68-3bd6-11e8-8954-0819a624c497"
      }
    }

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

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

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