API文档>云主机>云主机相关>查询云主机
  • 接口说明
  • 接口调试

查询云主机

更新时间：2019-12-11 09:11:16

描述

查询云主机，可查询一条或多条记录，可根据名称等多个查询条件查询。

请求参数

参数名参数类型是否必填参数说明
Region String 是

机房标识，取值参见地域列表
Action String 是

操作方法
DueStartTime String 否

到期开始时间 格式yyyy-MM-dd HH:mm:ss
DueEndTime String 否

到期结束时间 格式yyyy-MM-dd HH:mm:ss
ProductStatus String 否

产品状态，取值范围：

  • NORMAL：正常
  • OVERTIMER：过期
  • ARREARAGE：欠费
PayType String 否

付费类型，取值范围：

  • PREPAID：包年包月
  • PROBATION：试用
ImageId String 否

镜像Id
Offset Integer 否

记录偏移量，不指定取0
Count Integer 否

记录数量，不指定为全部
InstanceSeries String 否

主机系列，取值范围：

  • SERIES_STANDARD：普通型
  • SERIES_SUPERCOMPUTER：计算增强型
Id.N String 否

云主机Id，支持多个查询，如Id.0=aa&Id.1=bb
Name String 否

云主机名称
Status String 否

云主机运行状态，取值范围：

  • 开机：START
  • 关机：STOP
  • 异常：ERROR
  • 创建中：CREATING
  • 开机中：STARTING
  • 关机中：STOPING
  • 暂停中：PAUSING
  • 已暂停：PAUSED
  • 取消暂停中：UNPAUSING
  • 重启中：REBOOTING
  • 修改配置中:RESIZING
  • 迁移中：MIGRATE
  • 删除中：DELETING
  • 删除错误：DELETE_ERROR
  • 重装中：REBUILDING
  • 创建失败：CREATE_ERROR
  • 快照还原中：ROLLING_BACK
FirewallId.N String 否

防火墙Id，支持多个查询，如FirewallId.0=aa&FirewallId.1=bb
StartTime String 否

创建开始时间 格式yyyy-MM-dd HH:mm:ss
EndTime String 否

创建结束时间 格式yyyy-MM-dd HH:mm:ss

返回参数

名称 类型 说明
Action String 执行的操作
TaskId String 请求标识
TotalCount Integer 记录总数量
InstanceSet InstanceItemType 由InstanceItemType组成的数组格式，返回实例信息

InstanceItemType 节点

实例信息的数据类型

名称 类型 说明
Id String 实例标识
Name String 名称
Status String 实例状态 云主机运行状态，取值范围： 开机：START 关机：STOP 异常：ERROR 创建中：CREATING 开机中：STARTING 关机中：STOPING 暂停中：PAUSING 已暂停：PAUSED 取消暂停中：UNPAUSING 重启中：REBOOTING 修改配置中:RESIZING 迁移中：MIGRATE 删除中：DELETING 删除错误：DELETE_ERROR 重装中：REBUILDING 创建失败：CREATE_ERROR 快照还原中：ROLLING_BACK
ProductStatus String 产品状态。取值范围：NORMAL-正常; OVERTIMER-过期; ARREARAGE-欠费
PayType String 支付类型 ONDEMAND：按量付费；PREPAID：包年包月。临时实例忽略此参数
Task String 任务号
ProductModelId String 产品型号ID
Cpu Integer CPU 核数
Memory String 内存大小，单位是 GB
Password String 密码
InitPassword String 初始密码
KeyPair String 密钥对ID
KeyPairName String 密钥对名称
CreateTime String 创建时间
DueTime String 到期时间
FirewallId String 防火墙ID
FirewallName String 防火墙名称
ImageId String 镜像ID
ImageName String 镜像名称
InstanceSeries String 主机系列
InterfaceSet InterfaceSetItemType 由InterfaceSetItemType组成的数组格式，返回私有网络的信息
Internet InternetItemType 由InternetItemType组成的数组格式，返回公网IP的信息
VolumeSet VolumeSetItemType 由VolumeSetItemType组成的数组格式，返回云硬盘的信息

InterfaceSetItemType 节点

私有网络信息的数据类型

名称 类型 说明
Id String 网卡标识
NetworkId String 网络标识
NetworkName String 网络名称
MacAddress String 网卡地址
IpAddress String IP 地址
Status String 状态
Uuid String 网卡UUID

InternetItemType 节点

公网IP信息的数据类型

Id String 网卡标识
Id String IP标识
IpAddress String IP地址
Bandwidth Integer IP带宽,单位：Mbps
PayType String 支付类型 ONDEMAND：按量付费；PREPAID：包年包月；PROBATION 试用。
DueTime String 到期时间
AllocateTime String 购买时间
ProductStatus String 产品状态
ProductModelId String 产品型号ID
ProductType String 产品类型

VolumeSetItemType 节点

云硬盘信息的数据类型

Id String 云硬盘标识
Id Integer 云硬盘标识
Name String 名称
Size String 大小，单位GiB
Uuid String 云硬盘UUID
Index String 挂载位置，0 标识系统盘，其它标识数据盘
PayType String 支付类型 ONDEMAND：按量付费；PREPAID：包年包月；PROBATION 试用。
DueTime String 到期时间
CreateTime String 创建时间
ProductStatus String NORMAL-正常，OVERTIMER-过期，ARREARAGE-欠费

请求示例

https://api.chinac.com/v2/?Action=DescribeInstances
&Region=cn-wuxi
&Id.0=xxx
&<公共请求参数>

返回示例

{
    "code": 10000,
    "message": "",
    "data": {
        "TaskId": "az020160902171445364",
        "Action": "DescribeInstances",
        "TotalCount": 1,
        "InstanceSet": [{
        "Id": "i-t79ih48g8r64s",
            "Name": "cec170508g9cG",
            "Status": "START",
            "Task": "NONE",
            "ProductStatus": "NORMAL",
            "PayType": "PREPAID",
            "ProductModelId": "402124",
            "ProductType": "2核8G_SERIES_STANDARD",
            "Cpu": 2,
            "Memory": 8.0,
            "Password": "oA87A6bXvm6yAz+/uauEuA==",
            "KeyPair": null,
            "CreateTime": "2017-05-08T16:44:27 +0800",
            "DueTime": "2017-06-08T16:44:27 +0800",
            "CloseTime": "2017-06-08T17:44:27 +0800",
            "InterfaceSet": [{
                "Id": "p-lx9ih48g8l8b",
                "InstanceId": "i-t79ih48g8r64s",
                "NetworkId": "n-8q9ih3ka70250",
                "SubnetId": "s-qy9ih3ka7027r",
                "MacAddress": "fa:16:3e:fc:a9:ad",
                "IpAddress": "10.10.10.12",
                "Status": "ON_LINE",
                "Uuid": "385689f0-1dd6-4695-a2ca-09b9e0210e64",
                "Type": "CUSTOMER"
            }],
            "Internet": null,
            "VolumeSet": [{
                "Id": "v-379ih48g919j",
                "Name": "cec170508g9cGdata1",
                "Type": "normal",
                "PayType": "PREPAID",
                "Size": 20,
                "Index": 1,
                "DueTime": "2017-06-08T16:45:01 +0800",
                "CloseTime": "2017-06-08T17:45:01 +0800",
                "CreateTime": "2017-05-08T16:45:01 +0800",
                "Uuid": "f06894e9-fb18-4d01-8d92-178df43c1fb4",
                "ProductStatus": "NORMAL"
            },
            {
                "Id": "v-yr9ih48g8k95l",
                "Name": "cec170508g9cGsys",
                "Type": "normal",
                "PayType": "PREPAID",
                "Size": 40,
                "Index": 0,
                "DueTime": "2017-06-08T16:44:27 +0800",
                "CloseTime": null,
                "CreateTime": "2017-05-08T16:44:56 +0800",
                "Uuid": "15c6439c-57c8-4567-8fa4-5ec62d886e16",
                "ProductStatus": "NORMAL"
            }],
            "Uuid": "3e542822-7130-45d3-8af4-4a75dd6cebb1",
            "OwnerId": "18359229",
            "FirewallId": "f-um9ih3ka7i4",
            "ImageId": "t-189ih18e5t42t",
            "OsName": "Windows",
            "OsVersion": "2008",
            "OsBit": "64",
            "InitPassword": "qiCx9VopYs",
            "UserId": "18359229",
            "Locked": false,
            "IdLong": "i-t79ih48g8r64s-3e542822-7130-45d3-8af4-4a75dd6cebb1",
            "HostName": "controller",
            "InstanceSeries": "SERIES_STANDARD",
            "SeriesName": "普通型"
        }]
    }
}
*
*