文档首页 > > API参考> OpenStack Nova API> 生命周期管理> 查询云服务器详情列表

查询云服务器详情列表

分享
更新时间: 2020/01/17 GMT+08:00

功能介绍

查询云服务器详情信息列表。

URI

GET /v2.1/{project_id}/servers/detail{?changes-since,image,flavor,name,status,limit,marker,not-tags,reservation_id,ip}

参数说明请参见 表1
表1 参数说明

参数

是否必选

描述

project_id

项目ID。

获取方法请参见获取项目ID

请求消息

请求参数如表2所示。

表2 请求参数

参数

是否必选

参数类型

描述

changes-since

String

云服务器上次更新状态的时间戳信息,过滤出该时间戳之后状态更新的云服务器。格式符合ISO 8601,CCYY-MM-DDThh:mm:ss+/-hh:mm,例如:2018-01-17T03:03:32Z 。

image

Object

云服务器镜像信息,对镜像创的弹性云服务器该属性通常返回镜像id和链接。

详情请参见。表12

flavor

String

云服务器规格ID,匹配规则为模糊匹配。

name

String

云服务器名称,匹配规则为模糊匹配。

status

String

云服务器状态。

取值范围:

ACTIVE、BUILD、ERROR、HARD_REBOOT、MIGRATING、REBOOT、REBUILD、RESIZE、REVERT_RESIZE、SHUTOFF、VERIFY_RESIZE

直到2.37微版本,非上面范围的status字段将返回空列表,2.38之后的微版本,将返回400错误。

弹性云服务器状态说明请参考云服务器状态

limit

Integer

查询返回云服务器数量限制。

marker

String

从marker指定的云服务器ID的下一条数据开始查询。

tags

String

查询tag字段中包含该值的云服务器。

not-tags

String

查询tag字段中不包含该值的云服务器,值为标签的Key。

说明:

系统近期对标签功能进行了升级。如果之前添加的Tag为“Key.Value”的形式,则查询的时候需要使用“Key”来查询。

例如:之前添加的tag为“a.b”,则升级后,查询时需使用“not-tags=a”。

reservation_id

String

批量创建弹性云服务器时,指定返回的ID,用于查询本次批量创建的弹性云服务器。

sort_key

String

查询结果按弹性云服务器属性排序,默认排序顺序为created_at逆序。

取值范围:created_at,availability_zone,display_name,host,instance_type_id,key_name,project_id,user_id,updated_at,uuid,vm_state

ip

String

IPv4地址过滤结果。

响应消息

响应参数如表3所示。

表3 响应参数

参数

参数类型

描述

servers

Array of objects

查询云服务器信息列表,详情请参见表4

servers_links

Array of objects

分页查询时,查询下一页数据链接,详情请参见表7

表4 servers字段数据结构说明

参数

参数类型

描述

name

String

云服务器名称。

id

String

云服务器唯一标识ID。

status

String

云服务器当前状态信息。

取值范围:

ACTIVE、BUILD、DELETED、ERROR、HARD_REBOOT、MIGRATING、PASSWORD、PAUSED、REBOOT、REBUILD、RESIZE、REVERT_RESIZE、SHUTOFF、SHELVED、SHELVED_OFFLOADED、SOFT_DELETED、SUSPENDED、VERIFY_RESIZE

弹性云服务器状态说明请参考云服务器状态

created

String

云服务器创建时间。时间格式例如:2019-05-22T07:48:53Z

updated

String

云服务器上一次更新时间。时间格式例如:2019-05-22T07:48:53Z

flavor

Object

云服务器规格信息。

详情请参见表5

image

String

云服务器镜像信息。

弹性云服务器属性通常返回镜像ID和链接。

tenant_id

String

云服务器所属租户ID。即项目id,与project_id表示相同的概念。

key_name

String

SSH密钥名称。

user_id

String

云服务器所属用户ID。

metadata

Object

云服务器元数据。

hostId

String

云服务器对应的主机ID。

addresses

Object

云服务器对应的网络地址信息。

详情请参见表6

security_groups

Array of objects

云服务器所属安全组列表。

详情请参见表10

links

Array of objects

云服务器相关快捷链接信息。

详情请参见表7

OS-DCF:diskConfig

String

扩展属性,磁盘配置方式。对镜像启动云服务器生效。

取值范围:

  • AUTO: API使用单个分区构建目标磁盘大小的云服务器。 API会自动调整文件系统以适应整个分区。
  • MANUAL:API使用源映像中的分区方案和文件系统构建服务器。如果目标磁盘较大,则API不分区剩余的磁盘空间。

OS-EXT-AZ:availability_zone

String

扩展属性,可用区编码。

OS-EXT-SRV-ATTR:host

String

扩展属性,云服务器宿主名称。

OS-EXT-SRV-ATTR:hypervisor_hostname

String

扩展属性,hypervisor主机名。

OS-EXT-SRV-ATTR:instance_name

String

扩展属性,云服务器实例ID。

OS-EXT-STS:power_state

Integer

扩展属性,云服务器电源状态。

取值范围:0,1,2,3,4

  • 0 : pending
  • 1 : running
  • 2 : paused
  • 3 : shutdown
  • 4 : crashed

OS-EXT-STS:task_state

String

扩展属性,云服务器任务状态。

取值范围请参考云服务器状态表3。

OS-EXT-STS:vm_state

String

扩展属性,云服务器状态。

取值范围:

ACTIVE,BUILDING,STOPPED,RESIZED,PAUSED,SUSPENDED,RESCUED,ERROR,DELETED,SOFT_DELETED,SHELVED,SHELVED_OFFLOADED

弹性云服务器状态说明请参考云服务器状态

OS-SRV-USG:launched_at

String

扩展属性,云服务器启动时间。时间格式例如:2019-05-22T07:48:19.000000

OS-SRV-USG:terminated_at

String

扩展属性,云服务器删除时间。

时间格式例如:2019-05-22T07:48:19.000000

os-extended-volumes:volumes_attached

Array of objects

云服务器挂载的云磁盘信息。

详情请参见表9

fault

Object

弹性云服务器故障信息。

可选参数,在弹性云服务器状态为ERROR且存在异常的情况下返回。

详情参见 表11 fault字段数据结构说明

description

String

弹性云服务器的描述信息。

微版本2.19后支持。

host_status

String

nova-compute状态。

  • UP:服务正常
  • UNKNOWN:状态未知
  • DOWN:服务异常
  • MAINTENANCE:维护状态
  • 空字符串:弹性云服务器无主机信息

微版本2.16后支持。

OS-EXT-SRV-ATTR:hostname

String

弹性云服务器的主机名。

微版本2.3后支持。

OS-EXT-SRV-ATTR:reservation_id

String

批量创建场景,弹性云服务器的预留ID。

微版本2.3后支持。

OS-EXT-SRV-ATTR:launch_index

Integer

批量创建场景,弹性云服务器的启动顺序。

微版本2.3后支持。

OS-EXT-SRV-ATTR:kernel_id

String

若使用AMI格式的镜像,则表示kernel image的UUID;否则,留空。

微版本2.3后支持。

OS-EXT-SRV-ATTR:ramdisk_id

String

若使用AMI格式镜像,则表示ramdisk image的UUID;否则,留空。微版本2.3后支持

OS-EXT-SRV-ATTR:root_device_name

String

弹性云服务器系统盘的设备名称。

微版本2.3后支持。

OS-EXT-SRV-ATTR:user_data

String

创建弹性云服务器时指定的user_data。

微版本2.3后支持。

tags

Array of strings

云服务器的标签列表。

微版本2.26,如果不使用微版本查询,响应中无tags字段。

系统近期对标签功能进行了升级,升级后,返回的tag值遵循如下规则:
  • key与value使用“=”连接,如“key=value”。
  • 如果value为空字符串,则仅返回key。

locked

Boolean

当云服务器被锁时为True,否则为False。

微版本2.9后支持。

accessIPv4

String

预留属性。

accessIPv6

String

预留属性。

config_drive

String

预留属性。

progress

Integer

预留属性。

表5 flavor字段数据结构说明

参数

参数类型

描述

id

String

云服务器类型ID。

links

Array of objects

云服务器类型相关快捷链接信息,详情请参见表7

表6 addresses字段数据结构说明

参数

参数类型

描述

弹性云服务器所属网络的名称。

Array of objects

弹性云服务器所属网络信息。

  • key为网络名名称,如“demo_net”。
  • value为网络详细信息。

详情请参见表8

表7 servers_links、links字段数据结构说明

参数

参数类型

描述

rel

String

快捷链接标记名称。

href

String

对应快捷链接。

表8 弹性云服务器所属网络信息数据结构说明

参数

参数类型

描述

addr

String

IP地址信息。

version

Integer

IP地址类型,值为4或6。

  • 4:IP地址类型是IPv4
  • 6:IP地址类型是IPv6

OS-EXT-IPS-MAC:mac_addr

String

扩展属性,MAC地址。

OS-EXT-IPS:type

String

扩展属性,分配IP地址方式。

表9 os-extended-volumes:volumes_attached字段数据结构说明

参数

参数类型

描述

id

String

云硬盘ID。

delete_on_termination

Boolean

一个标志,指示在删除服务器时是否删除附加的卷。、

默认情况下,这是False

微版本2.3后支持

表10 security_groups字段数据结构说明

参数

参数类型

描述

name

String

安全组名称或者uuid。

表11 fault字段数据结构说明

参数

参数类型

描述

code

Integer

错误码。

created

String

异常出现的时间。

message

String

异常描述信息。

details

String

异常详情信息。可选参数,在非空条件下才返回。

表12 image字段数据结构说明

参数

参数类型

描述

id

String

镜像ID。

links

Array of objects

镜像相关标记快捷链接信息,详情请参见。表7

请求示例

GET https://{endpoint}/v2.1/{project_id}/servers/detail

响应示例

{
    "servers": [
        {
            "addresses": {
                "68269e6e-4a27-441b-8029-35373ad50bd9": [
                    {
                        "addr": "192.168.0.3", 
                        "version": 4
                    }
                ]
            }, 
            "created": "2012-09-07T16:56:37Z", 
            "flavor": {
                "id": "1", 
                "links": [
                    {
                        "href": "http://openstack.example.com/openstack/flavors/1", 
                        "rel": "bookmark"
                    }
                ]
            }, 
            "hostId": "16d193736a5cfdb60c697ca27ad071d6126fa13baeb670fc9d10645e", 
            "id": "05184ba3-00ba-4fbc-b7a2-03b62b884931", 
            "image": "", 
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/servers/05184ba3-00ba-4fbc-b7a2-03b62b884931", 
                    "rel": "self"
                }, 
                {
                    "href": "http://openstack.example.com/openstack/servers/05184ba3-00ba-4fbc-b7a2-03b62b884931", 
                    "rel": "bookmark"
                }
            ], 
            "metadata": {},                         
            "name": "new-server-test", 
            "progress": 0, 
            "status": "ACTIVE", 
            "tenant_id": "openstack", 
            "updated": "2012-09-07T16:56:37Z", 
            "user_id": "fake"
        }
    ]
}

返回值

请参考通用请求返回值

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区