帮助与文档

我们为你提供丰富、详尽的使用指南以及产品文档

DescribeVxnetInstances

获取私有网络中的主机。

可通过主机ID，映像ID，主机配置类型，主机状态作为过滤条件进行筛选。

Request Parameters

Parameter name Type Description Required
vxnet String 私有网络ID Yes
instances.n String 主机ID No
instance_type String 主机配置类型 No
status String 主机状态 No
image String 映像ID No
offset Integer 数据偏移量，默认为0 No
limit Integer 返回数据长度，默认为20，最大100 No
zone String 区域 ID，注意要小写 Yes

公共参数

Response Elements

Name Type Description
action String 响应动作
instance_set Array JSON 格式的私有网络的主机列表，每项数据可见下面 ResponseItemType
total_count Integer 根据过滤条件得到的主机总数
ret_code Integer 执行成功与否，0 表示成功，其他值则为错误代码

ResponseItemType

Name Type Description
vxnet_id String 私有网络 ID
instance_id String 主机ID
instance_name String 主机名称
description String 主机描述
instance_type String 主机类型，配置列表请参考 Instance Types。
vcpus_current Integer 主机CPU核心数目。
memory_current Integer 主机内存大小，单位为MB。
status String 主机状态，有效值为pending, running, stopped, suspended，terminated, ceased。
pending： 等待被创建
running： 运行中
stopped： 已关机
suspended： 由于欠费，已被暂停使用
terminated： 已被删除，但处于此状态的主机在2小时之内仍可以被恢复为 running 状态
ceased： 已被彻底删除，处于此状态的主机无法恢复
transition_status String 主机过渡状态，有效值为creating, starting, stopping, restarting, suspending，resuming，terminating，recovering，resetting。
creating： 创建中，由 pending 状态变成 running 状态
starting： 启动中，由 stopped 状态变成 running 状态
stopping： 关闭中，由 running 状态变成 stopped 状态
restarting： 重启中
suspending： 欠费暂停中，由 running/stopped 状态变成 suspended 状态
resuming： 恢复中，由 suspended 状态变成 running 状态
terminating： 删除中，由 running/stopped/suspended 状态变成 terminated 状态
recovering： 恢复中，由 terminated 状态变成 running 状态
resetting： 操作系统重置中
create_time TimeStamp 主机创建时间，为UTC时间，格式可参见 ISO8601.
status_time TimeStamp 主机最近一次状态变更时间，为UTC时间，格式可参见 ISO8601.
image_id String 主机的模板ID。
dhcp_options Dict 私有网络中针对该主机的 DHCP 配置。
private_ip String 主机的位于该私有网络的IP。

Example

Example Request:

https://api.qingcloud.com/iaas/?action=DescribeVxnetInstances
&vxnet=vxnet-ytuyg2q
&status=running
&limit=1
&COMMON_PARAMS

Example Response:

{
  "action":"DescribeVxnetInstancesResponse",
  "instance_set":[
    {
      "vcpus_current":1,
      "instance_id":"i-syx7qtud",
      "image_id":"centos64x64",
      "vxnet_id":"vxnet-ytuyg2q",
      "sequence":0,
      "sub_code":0,
      "transition_status":"",
      "instance_name":"",
      "instance_type":"small_b",
      "create_time":"2013-08-30T09:13:37Z",
      "status":"running",
      "private_ip":"192.168.1.2",
      "description":null,
      "status_time":"2013-08-30T09:13:37Z",
      "nic_id":"52:54:5b:e3:69:f4",
      "dhcp_options":{
        "val2":"domain-name-servers=8.8.8.8",
        "router_static_id":"rtrs-jak6z5nx"
      },
      "memory_current":1024
    }
  ],
  "ret_code":0,
  "total_count":1
}