DescribeVxnetInstances
获取私有网络中的云服务器。
可通过云服务器 ID,镜像 ID,云服务器配置类型,云服务器状态作为过滤条件进行筛选。
请求参数
参数 | 参数类型 | 描述 | 是否必选 |
---|---|---|---|
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 |
除上述请求参数外,还包含公共参数。
返回数据
参数 | 参数类型 | 描述 |
---|---|---|
action |
String |
响应动作 |
instance_set |
Array |
JSON 格式的私有网络的云服务器列表,每项数据详见 ResponseItemType |
total_count |
Integer |
根据过滤条件得到的云服务器总数 |
ret_code |
Integer |
执行成功与否,0 表示成功,其他值则为错误代码 |
参数 | 参数类型 | 描述 |
---|---|---|
vxnet_id |
String |
私有网络 ID |
instance_id |
String |
云服务器ID |
instance_name |
String |
云服务器名称 |
description |
String |
云服务器描述 |
instance_type |
String |
云服务器类型。 |
vcpus_current |
Integer |
云服务器CPU核心数目。 |
memory_current |
Integer |
云服务器内存大小,单位为MB。 |
status |
String |
云服务器状态,有效值为pending, running, stopped, suspended,terminated, ceased。 |
transition_status |
String |
云服务器过渡状态,有效值为creating、starting、stopping、restarting、suspending、resumin、terminating、recovering、resetting。 |
create_time |
TimeStamp |
云服务器创建时间,为UTC时间,格式可参见 ISO8601。 |
status_time |
TimeStamp |
云服务器最近一次状态变更时间,为UTC时间,格式可参见 ISO8601。 |
image_id |
String |
云服务器的模板ID。 |
dhcp_options |
Dict |
私有网络中针对该云服务器的 DHCP 配置。 |
private_ip |
String |
云服务器的位于该私有网络的IP。 |
请求示例
https://api.qingcloud.com/iaas/?action=DescribeVxnetInstances
&vxnet=vxnet-ytuyg2q
&status=running
&limit=1
&COMMON_PARAMS
返回示例
{
"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
}