功能介绍
查询云服务器详情信息列表。

调试
您可以在API Explorer中调试该接口。
URI
GET /v2.1/{project_id}/servers/detail?changes-since={changes-since}&image={image}&flavor={flavor}&name={name}&status={status}&limit={limit}&marker={marker}¬-tags={not-tags}&reservation_id={reservation_id}&ip={ip}
参数说明请参见表1。
表1 路径参数
参数
是否必选
描述
project_id
是
项目ID。
获取方法请参见获取项目ID。
表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
直到2.37微版本,非上面范围的status字段将返回空列表,微版本2.38及以上的版本,将返回400错误。
云服务器状态说明请参考云服务器状态。
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。
表4 servers字段数据结构说明
参数
参数类型
描述
name
String
云服务器名称。
id
String
云服务器标识ID。
status
String
云服务器当前状态信息。
取值范围:
ACTIVE、BUILD、DELETED、ERROR、HARD_REBOOT、MIGRATING、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
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<String, Object>结构。
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
扩展属性,云服务器任务状态。
取值范围请参考云服务器状态表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
云服务器挂载的云磁盘信息。
详情请参见表8。
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。
微版本2.47及以上版本不支持。
links
Array of objects
云服务器类型相关快捷链接信息,详情请参见表6。
微版本2.47及以上版本不支持。
vcpus
Integer
该云服务器规格对应的CPU核数。
微版本2.47及以上版本支持。
ram
Integer
该云服务器规格对应的内存大小,单位为MB。
微版本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)字段数据结构说明。
微版本2.47及以上版本支持。
表6 servers_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地址方式。
表8 os-extended-volumes:volumes_attached字段数据结构说明
参数
参数类型
描述
id
String
云硬盘ID。
delete_on_termination
Boolean
一个标志,指示在删除服务器时是否删除附加的卷。、
默认情况下,这是False
微版本2.3及以上版本支持。
表9 security_groups字段数据结构说明
参数
参数类型
描述
name
String
安全组名称或者uuid。
表10 fault字段数据结构说明
参数
参数类型
描述
code
Integer
错误码。
created
String
异常出现的时间。
message
String
异常描述信息。
details
String
异常详情信息。可选参数,在非空条件下才返回。
表11 image字段数据结构说明
参数
参数类型
描述
id
String
镜像ID。
links
Array of objects
镜像相关标记快捷链接信息,详情请参见表6
表12 os: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"
}
]
}
返回值
请参考通用请求返回值。
华为云共建智能世界云底座[52] 华为公有云专属云主机DeH服务[51] 华为云场景化解决方案[49] 华为公有云产品[44] 华为云云主机[43] 华为云产品服务[43] 华为云服务器应用[43] 华为弹性云服务器[39] 华为公有云架构解决方案[38] 华为云提供的服务[37] 华为虚拟私有云vpc[37] 华为公有云介绍[32] 华为公有云提供哪些计算服务[30] 华为云漏洞扫描[27] 华为云软件开发服务[27] 华为公有云和私有云区别[27] 华为云域名注册[26] 华为云官网登陆[26] 华为公有云解决方案[26] 华为私有云产品有哪些[26] 华为私有云服务[25] 华为云数据库[23] 华为云安全[22] 华为公有云官网[22] 华为私有云的搭建方案[22] 华为云弹性云服务器应用[21] 华为公有云平台[20] 华为公有云行业解决方案[20] 华为私有云解决方案服务定制领导者[20] [19] 华为私有云服务器[19] 华为私有云网格结构[19] 华为公有云视讯解决方案[18] 华为云官网[17] 华为云速建站[17] 华为私有云架构[17] 华为云优势[16] 华为云服务器[16] 华为私有云部署架构[16] 华为云企业邮箱服务 (SAAS[15] 华为云邮箱[15] 华为公有云是什么[15] 华为公有云架构[15] 华为云迁移解决方案[14] 华为公有云解决方案服务定制领导者[14] 华为私有云解决方案[14] 云邮箱)[13] 华为云园区解决方案[13] 华为云服务总代理[13] 华为云速智能客服[13] 华为公有云服务[13] 华为私有云搭建方案[13] 云与计算咨询服务[12] 云与计算培训服务[11] 华为云备份[11] 华为云服务器配置[11] 华为云服务服务中心[11] 华为云服务核心分销商[11] 华为公有云[11] 华为私有云搭建[11] 云迁移与运营支撑服务[10] 公有云私有云混合云[10] 华为云服务器ECS[10] 华为云服务器成功案例[10] 华为云解决方案[10] 华为公有云通用解决方案[9] 华为智慧云课堂解决方案[9] 华为云数据解决方案[8] 华为云是什么[8] 华为私有云平台[8] 云与计算客户支持与运维使能服务[7] 华为云官网网站[7] 华为云智慧教育解决方案[7] 华为云智慧校园解决方案[7] 华为云桌面系统集成商[7] 华为云经销商[7] 华为代理公司有哪些[7] 华为私有云方案[7] 智慧教育云平台解决方案[7] 华为云服务器试用[6] 华为云网站建设服务器[6] 华为手机代理加盟[6] 华为私有云[6] 大数据使能服务[6] 智慧教育云计算解决方案[6] 华为云云主机 [5] 华为云智慧***解决方案[5] 华为云桌面总代理商[5] 云与计算客户支持服务[4] 华为云产品介绍[4] 华为云智慧制造解决方案[4] 华为云场景化解决方案[3] 华为公有云官网[3] 华为公有云通用解决方案[3] 华为弹性云服务器[3] 华为公有云产品 [3] 华为云产品服务[2] 华为云域名注册[2] 华为云数据库[2] 华为云智慧校园解决方案[2] 华为云服务器应用[2] 华为云服务器成功案例[2] 华为云软件开发服务[2] 华为公有云产品[2] 华为公有云介绍[2] 华为公有云和私有云区别[2] 华为公有云服务[2] 华为公有云架构[2] 华为公有云架构解决方案[2] 华为公有云视讯解决方案[2] 华为公有云解决方案[2] 华为私有云产品有哪些[2] 华为私有云服务[2] 华为私有云架构[2] 智慧教育云计算解决方案[2] 云规划设计与实施服务[2] 云邮箱[2] 华为云产品报价[2] 华为公有云通用解决方案 [2] 华为云服务器成功案例[1] 华为云桌面系统集成商[1] 云与计算客户支持与运维使能服务[1] 云迁移与运营支撑服务[1] 云迁移与运营支撑服务 [1] 华为云共建智能世界云底座[1] 华为云备份[1] 华为云安全[1] 华为云官网登陆[1] 华为云弹性云服务器应用[1] 华为云提供的服务[1] 华为云数据解决方案[1] 华为云智慧制造解决方案[1] 华为云服务器[1] 华为云服务核心分销商 [1] 华为云漏洞扫描[1] 华为云迁移解决方案 [1] 华为云速智能客服[1] 华为云邮箱[1] 华为公有云专属云主机DeH服务[1] 华为公有云是什么[1] 华为公有云行业解决方案[1] 华为私有云搭建[1] 华为私有云方案[1] 华为私有云服务.华为公有云专属云主机DeH服务.华为云产品报价[1] 华为私有云的搭建方案[1] 华为私有云网格结构[1] 华为私有云解决方案[1] 华为私有云部署架构[1] 为云产品服务[1] 云与计算咨询服务 [1] 云与计算客户支持与运维使能服务 [1] 云与计算客户支持与运维使能服务 云与计算客户支持服务[1] 华为云是什么 [1] 华为云软件开发服[1] 华为云速智能客服 [1] 华为代理加盟[1] 华为公有云架构解决方案 [1] 华为公有云解决方案服务定制领导者 [1] 华为弹性云[1] 华为弹性云服务器 华为云域名注册 华为云服务器应用[1] 华为私有云搭建 [1] 华为私有云搭建方案 [1] 华为私有云部署架构 [1] 大数据使能服务 [1] 撒[1]