# 查询云服务器详情列表（废弃） - NovaListServersDetails #### 功能介绍 查询云服务器详情信息列表。 当前API已废弃，请使用[查询云服务器详情列表 - ListServersDetails](https://support.huaweicloud.com/api-ecs/zh-cn_topic_0094148850.html)。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=ECS&api=NovaListServersDetails)中调试该接口。 #### URI GET /v2.1/{project_id}/servers/detail 参数说明请参见[表1]。 表1路径参数 | 参数 | 是否必选 | 描述 | |:---|:---|:---| | project_id | 是 | 项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-ecs/ecs_01_0016.html)。 | 表2查询参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | changes-since | 否 | String | 云服务器上次更新状态的时间戳信息，过滤出该时间戳之后状态更新的云服务器。格式符合ISO 8601，CCYY-MM-DDThh:mm:ss+/-hh:mm，例如：2018-01-17T03:03:32Z 。 | | image | 否 | String | 镜像ID。 在使用image作为条件过滤时，不能同时支持其他过滤条件和分页条件。如果同时指定image及其他条件，则以image条件为准；当条件不含image时，接口功能不受限制。 | | flavor | 否 | String | 云服务器规格ID，匹配规则为模糊匹配。 | | name | 否 | String | 云服务器名称，匹配规则为模糊匹配。 | | status | 否 | String | 云服务器状态。 取值范围： ACTIVE、BUILD、ERROR、HARD_REBOOT、MIGRATING、REBOOT、REBUILD、RESIZE、REVERT_RESIZE、SHUTOFF、VERIFY_RESIZE、DELETED、SHELVED、SHELVED_OFFLOADED 、UNKNOWN 直到2.37微版本，非上面范围的status字段将返回空列表，微版本2.38及以上的版本，将返回400错误。 云服务器状态说明请参考[云服务器状态](https://support.huaweicloud.com/api-ecs/ecs_08_0002.html)。 | | limit | 否 | Integer | 查询返回云服务器数量限制。 每页默认值是25，最多返回1000台云服务器的信息，如果数据量过大建议设置成100。 | | 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,auto_disk_config,availability_zone,display_description,display_name,host,host_name,image_ref,instance_type_id,kernel_id,key_name,launch_index,launched_at,locked_by,node,power_state,project_id,ramdisk_id,reservation_id,root_device_name,task_state,terminated_at,user_id,updated_at,uuid,vm_state | | ip | 否 | String | IPv4地址过滤结果，匹配规则为模糊匹配。 | #### 请求消息 无 #### 响应消息 响应参数如[表3]所示。 表3响应参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | servers | Array of objects | 查询云服务器信息列表，详情请参见[表4]。 | | servers_links | Array of objects | 分页查询时，查询下一页数据链接，详情请参见[表6]。 | 表4servers字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | 云服务器名称。 | | id | String | 云服务器唯一标识ID。 | | status | String | 云服务器当前状态信息。 取值范围： ACTIVE、BUILD、ERROR、HARD_REBOOT、MIGRATING、REBOOT、REBUILD、RESIZE、REVERT_RESIZE、SHUTOFF、VERIFY_RESIZE、DELETED、SHELVED、SHELVED_OFFLOADED 、UNKNOWN 云服务器状态说明请参考[云服务器状态](https://support.huaweicloud.com/api-ecs/ecs_08_0002.html)。 | | created | String | 云服务器创建时间。时间格式例如：2019-05-22T07:48:53Z | | updated | String | 云服务器最近一次更新时间，例如开机、关机、重启等操作。时间格式例如：2019-05-22T07:48:53Z | | flavor | Object | 云服务器规格信息。 详情请参见[表5]。 | | image | Object | 云服务器镜像信息，对镜像创的弹性云服务器该属性通常返回镜像id和链接。 详情请参见。[表11] | | tenant_id | String | 云服务器所属租户ID。即项目id，与project_id表示相同的概念。 | | key_name | String | SSH密钥名称。 | | user_id | String | 云服务器所属用户ID。 | | metadata | Object | 云服务器元数据。 | | hostId | String | 云服务器对应的主机ID。 | | addresses | Object | 云服务器对应的网络地址信息。 属性为Map\结构。 - key为网络名称，如"demo_net"。 - value为网络属性，详情请参见[表7]。 | | security_groups | Array of objects | 云服务器所属安全组列表。 详情请参见[表9] | | links | Array of objects | 云服务器相关快捷链接信息。 详情请参见[表6] | | os:scheduler_hints | Object | 弹性云服务器调度信息，参见[表12]。裸金属服务器场景不支持。仅在DEH专属主机的场景下存在该字段。 | | 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 | 扩展属性，云服务器任务状态。 取值范围请参考[云服务器状态](https://support.huaweicloud.com/api-ecs/ecs_08_0002.html)表3。 | | OS-EXT-STS:vm_state | String | 扩展属性，云服务器状态。 取值范围： ACTIVE,BUILDING,STOPPED,RESIZED,PAUSED,SUSPENDED,RESCUED,ERROR,DELETED,SOFT_DELETED,SHELVED,SHELVED_OFFLOADED 云服务器状态说明请参考[云服务器状态](https://support.huaweicloud.com/api-ecs/ecs_08_0002.html)。 | | 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 | 云服务器挂载的云磁盘信息。 详情请参见[表8]。 | | fault | Object | 云服务器故障信息。 可选参数，在云服务器状态为ERROR且存在异常的情况下返回。 详情参见 [表10]。 | | 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 | 预留属性。 | 表5flavor字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 云服务器类型ID。 微版本2.47及以上版本不支持。 | | links | Array of objects | 云服务器类型相关快捷链接信息，详情请参见[表6]。 微版本2.47及以上版本不支持。 | | vcpus | Integer | 该云服务器规格对应的CPU核数。 微版本2.47及以上版本支持。 | | ram | Integer | 该云服务器规格对应的内存大小，单位为MiB。 微版本2.47及以上版本支持。 | | disk | Integer | 该云服务器规格对应要求系统盘大小，0为不限制。 微版本2.47及以上版本支持。 | | ephemeral | Integer | 未使用。 微版本2.47及以上版本支持。 | | swap | Integer | 未使用。 微版本2.47及以上版本支持。 | | original_name | String | 云服务器规格名称 微版本2.47及以上版本支持。 | | extra_specs | Object | flavor扩展字段。 请参考：[os_extra_specs（flavor）字段数据结构说明](https://support.huaweicloud.com/api-ecs/ecs_05_0003.html)。 微版本2.47及以上版本支持。 | 表6servers_links、links字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | rel | String | 快捷链接标记名称。 | | href | String | 对应快捷链接。 | 表7弹性云服务器所属网络信息数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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地址方式。 | 表8os-extended-volumes:volumes_attached字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 云硬盘ID。 | | delete_on_termination | Boolean | 一个标志，指示在删除服务器时是否删除附加的卷。 默认情况下，这是False 微版本2.3及以上版本支持。 | 表9security_groups字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | 安全组名称或者uuid。 | 表10fault字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | Integer | 错误码。 | | created | String | 异常出现的时间。 | | message | String | 异常描述信息。 | | details | String | 异常详情信息。可选参数，在非空条件下才返回。 | 表11image字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 镜像ID。 | | links | Array of objects | 镜像相关标记快捷链接信息，详情请参见[表6] | 表12os:scheduler_hints参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | tenancy | 否 | Array of strings | 在指定的专属主机或者共享主机上创建弹性云服务器。 参数值为shared或者dedicated。 | | dedicated_host_id | 否 | Array of strings | 专属主机ID。 此属性仅在tenancy值为dedicated时有效。 | #### 请求示例 查询云服务器详情信息列表。 ``` 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": "s3.xlarge.2", "links": [ { "href": "http://openstack.example.com/openstack/flavors/s3.xlarge.2", "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" } ] } ``` #### 返回值 请参考[通用请求返回值](https://support.huaweicloud.com/api-ecs/ecs_07_0001.html)。