获取区域主机列表

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

1. 接口描述

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

本接口 (DescribeMachines) 用于获取区域主机列表。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeMachines
Version String 公共参数,本接口取值:2018-02-28
Region String 公共参数,本接口不需要传递此参数。
MachineType String 云主机类型。
  • CVM:表示虚拟主机
  • BM: 表示黑石物理机
  • MachineRegion String 机器所属地域。如:ap-guangzhou,ap-shanghai
    Limit Integer 返回数量,默认为10,最大值为100。
    Offset Integer 偏移量,默认为0。
    Filters.N Array of Filter 过滤条件。
  • Keywords - String - 是否必填:否 - 查询关键字
  • Status - String - 是否必填:否 - 客户端在线状态(OFFLINE: 离线 | ONLINE: 在线)
  • Version - String 是否必填:否 - 当前防护版本( PRO_VERSION:专业版 | BASIC_VERSION:基础版)

  • 每个过滤条件只支持一个值,暂不支持多个值“或”关系查询

    3. 输出参数

    参数名称 类型 描述
    Machines Array of Machine 主机列表
    TotalCount Integer 主机数量
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 获取区域主机列表

    输入示例

    https://yunjing.tencentcloudapi.com/?Action=DescribeMachines
    &MachineType=CVM
    &MachineRegion=ap-shanghai
    &Filters.0.Name=Keywords
    &Filters.0.Values.0=10.0.1.1
    &Limit=10
    &Offset=0
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "Machines": [
          {
            "IsProVersion": true,
            "MachineIp": "10.104.86.62",
            "MachineName": "h2-stevenyu",
            "MachineOs": "centos6.5",
            "MachineStatus": "ONLINE",
            "MachineWanIp": "132.104.86.62",
            "PayMode": "PREPAY",
            "Quuid": "6b6cd843-6bc1-4011-a74c-dc3fd26a7dd1",
            "Uuid": "9c6cd943-dbc1-4011-a74c-x4d9d26a7891",
            "VulNum": 10
          }
        ],
        "RequestId": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a",
        "TotalCount": 100
      }
    }

    5. 开发者资源

    API Explorer

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError 内部错误
    InvalidParameter.InvalidFormat 参数格式错误。
    InvalidParameter.MissingParameter 参数缺失。
    InvalidParameter.ParsingError 参数解析错误。
    MissingParameter 缺少参数错误