文档中心 API中心 生命周期管理 查询云服务器详情列表
在这篇文章中：

    查询云服务器详情列表

    功能介绍

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

    URI

    GET /v2.1/servers/detail?

    响应消息

    响应参数

    参数 参数类型 描述
    servers Array of objects 查询云服务器信息列表，详情请参见表1。

    表1 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 云服务器规格信息。详情请参见表2。
    image Object 云服务器镜像信息返回镜像id和链接。详情请参见。表8
    tenant_id String 云服务器所属项目id，与project_id表示相同的概念。
    key_name String SSH密钥名称。
    user_id String 云服务器所属用户ID。
    metadata Object 云服务器元数据。
    hostId String 云服务器对应的主机ID。
    addresses Object 云服务器对应的网络地址信息。key为网络名名称，如“demo_net”。value为网络详细信息。详情请参见表4。
    security_groups Array of objects 云服务器所属安全组列表。详情请参见表6。
    links Array of objects 云服务器相关快捷链接信息。详情请参见表3。
    OS-DCF:diskConfig String 扩展属性，磁盘配置方式。AUTO: 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，40 : pending1 : running2 : paused3 : shutdown4 : crashed
    OS-EXT-STS:task_state String 扩展属性，云服务器任务状态。
    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 云服务器挂载的云磁盘信息。详情请参见表5。
    fault Object 云服务器故障信息。可选参数，在云服务器状态为ERROR且存在异常的情况下返回。详情参见 表7。
    description String 云服务器的描述信息。
    locked Boolean 当云服务器被锁时为True，否则为False。
    accessIPv4 String 预留属性。
    accessIPv6 String 预留属性。
    config_drive String 预留属性。
    progress Integer 预留属性。

    表2 flavor字段数据结构说明

    参数 参数类型 描述
    id String 云服务器类型ID。
    links Array of objects 云服务器类型相关快捷链接信息，详情请参见表3。

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

    参数 参数类型 描述
    rel String 快捷链接标记名称。
    href String 对应快捷链接。

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

    参数 参数类型 描述
    addr String IP地址信息。
    version Integer IP地址类型，值为4或6。4：IP地址类型是IPv46：IP地址类型是IPv6
    OS-EXT-IPS-MAC:mac_addr String 扩展属性，MAC地址。
    OS-EXT-IPS:type String 扩展属性，分配IP地址方式。

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

    参数 参数类型 描述
    id String 云硬盘ID。
    delete_on_termination Boolean 一个标志，指示在删除服务器时是否删除附加的卷。

    表6 security_groups字段数据结构说明

    参数 参数类型 描述
    name String 安全组名称或者uuid。

    表7 fault字段数据结构说明

    参数 参数类型 描述
    code Integer 错误码。
    created String 异常出现的时间。
    message String 异常描述信息。
    details String 异常详情信息。可选参数，在非空条件下才返回。

    表8 image字段数据结构说明

    参数 参数类型 描述
    id String 镜像ID。
    links Array of objects 镜像相关标记快捷链接信息，详情请参见表3。

    请求示例

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

    响应示例

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    {
        "servers": [
            {
    		"OS-EXT-STS:task_state": null,
    		"addresses": {
    			"net1": [{
    				"OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:51:64:0a",
    				"version": 4,
    				"addr": "192.168.1.6",
    				"OS-EXT-IPS:type": "fixed"
    			}, {
    				"OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:51:64:0a",
    				"version": 4,
    				"addr": "10.119.0.184",
    				"OS-EXT-IPS:type": "floating"
    			}]
    		},
    		"links": [{
    			"href": "https://home.jcloud.sjtu.edu.cn:8774/v2.1/servers/8c28f0e3-c797-4c91-8802-63aaf13e1049",
    			"rel": "self"
    		}, {
    			"href": "https://home.jcloud.sjtu.edu.cn:8774/servers/8c28f0e3-c797-4c91-8802-63aaf13e1049",
    			"rel": "bookmark"
    		}],
    		"image": {
    			"id": "021de961-0406-4cc8-8323-46d39b6d1f0f",
    			"links": [{
    				"href": "https://home.jcloud.sjtu.edu.cn:8774/images/021de961-0406-4cc8-8323-46d39b6d1f0f",
    				"rel": "bookmark"
    			}]
    		}
        ]
    }

    返回值

    请参考通用请求返回值。