文档首页/ 弹性云服务器 ECS/ API参考/ API/ 生命周期管理/ 查询云服务器详情
更新时间：2025-10-11 GMT+08:00
查看PDF
分享

查询云服务器详情

功能介绍

查询弹性云服务器的详细信息。

该接口支持查询弹性云服务器的计费方式，以及是否被冻结。

调试

您可以在API Explorer中调试该接口。

URI

GET /v1/{project_id}/cloudservers/{server_id}

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

参数

是否必选

描述

project_id

是

项目ID。

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

server_id

是

云服务器ID。

请求消息

无

响应消息

响应参数如表2所示。
表2 响应参数

参数

参数类型

描述

server

Object

参数解释：

云服务器信息，详情请参见表3。

取值范围：

不涉及
表3 server字段数据结构说明

参数

参数类型

描述

status

String

参数解释：

弹性云服务器状态。

取值范围：

ACTIVE、BUILD、ERROR、HARD_REBOOT、MIGRATING、REBOOT、REBUILD、RESIZE、REVERT_RESIZE、SHUTOFF、VERIFY_RESIZE、DELETED、SHELVED、SHELVED_OFFLOADED 、UNKNOWN

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

updated

String

参数解释：

弹性云服务器最近一次更新时间，例如开机、关机、重启等操作。

时间格式例如：2019-05-22T03:30:52Z

取值范围：

不涉及

hostId

String

参数解释：

弹性云服务器所在主机的主机ID的哈希值。

取值范围：

不涉及

OS-EXT-SRV-ATTR:host

String

参数解释：

弹性云服务器所在主机的主机名称。

取值范围：

不涉及

addresses

Map<String, Array of objects>

参数解释：

弹性云服务器的网络属性。

取值范围：

  • key为网络名称，如“demo_net”。
  • value为网络属性，详情请参见表4。

key_name

String

参数解释：

弹性云服务器使用的密钥对名称。

取值范围：

不涉及

image

Object

参数解释：

弹性云服务器镜像信息。详情请参见：表7

取值范围：

不涉及

OS-EXT-STS:task_state

String

参数解释：

扩展属性，弹性云服务器当前任务的状态，请参考云服务器状态。

取值范围：

不涉及

OS-EXT-STS:vm_state

String

参数解释：

扩展属性，弹性云服务器当前状态，请参考云服务器状态。

取值范围：

不涉及

OS-EXT-SRV-ATTR:instance_name

String

参数解释：

扩展属性，弹性云服务器别名。

取值范围：

不涉及

OS-EXT-SRV-ATTR:hypervisor_hostname

String

参数解释：

扩展属性，弹性云服务器所在虚拟化主机名。

取值范围：

不涉及

flavor

Object

参数解释：

弹性云服务器规格信息。

详情请参见表1。

取值范围：

不涉及

id

String

参数解释：

弹性云服务器ID，格式为UUID。

取值范围：

不涉及

security_groups

Array of objects

参数解释：

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

详情请参见表3。

取值范围：

不涉及

OS-EXT-AZ:availability_zone

String

参数解释：

扩展属性，弹性云服务器所在可用区名称。

取值范围：

不涉及

user_id

String

参数解释：

创建弹性云服务器的用户ID，格式为UUID。

取值范围：

不涉及

name

String

参数解释：

弹性云服务器名称。

取值范围：

不涉及

created

String

参数解释：

弹性云服务器创建时间。

时间格式例如：2019-05-22T03:19:19Z

取值范围：

不涉及

tenant_id

String

参数解释：

弹性云服务器所属租户ID，即项目id，和project_id表示相同的概念，格式为UUID。

取值范围：

不涉及

OS-DCF:diskConfig

String

参数解释：

扩展属性， diskConfig的类型。

取值范围：

  • MANUAL，镜像空间不会扩展。
  • AUTO，系统盘镜像空间会自动扩展为与flavor大小一致。

accessIPv4

String

参数解释：

预留属性。

取值范围：

不涉及

accessIPv6

String

参数解释：

预留属性。

取值范围：

不涉及

progress

Integer

参数解释：

弹性云服务器进度。

取值范围：

0到100。

OS-EXT-STS:power_state

Integer

参数解释：

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

取值范围：

  • 0：NOSTATE
  • 1：RUNNING
  • 4：SHUTDOWN

config_drive

String

参数解释：

config drive信息。

取值范围：

不涉及

metadata

Map<String,String>

参数解释：

弹性云服务器元数据。详情请参见表5。

说明：

元数据包含系统默认添加字段和用户设置的字段。

取值范围：

不涉及

OS-SRV-USG:launched_at

String

参数解释：

弹性云服务器启动时间。时间格式例如：2019-05-22T03:23:59.000000

取值范围：

不涉及

OS-SRV-USG:terminated_at

String

参数解释：

弹性云服务器删除时间。

时间格式例如：2019-05-22T03:23:59.000000

取值范围：

不涉及

os-extended-volumes:volumes_attached

Array of objects

参数解释：

挂载到弹性云服务器上的磁盘。

详情请参见表4。

取值范围：

不涉及

description

String

参数解释：

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

取值范围：

不涉及

host_status

String

参数解释：

云服务器所在主机状态。

取值范围：

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

OS-EXT-SRV-ATTR:hostname

String

参数解释：

弹性云服务器的主机名。

取值范围：

不涉及

OS-EXT-SRV-ATTR:reservation_id

String

参数解释：

批量创建场景，弹性云服务器的预留ID，可以根据该id查询出批创的所有虚拟机。

取值范围：

不涉及

OS-EXT-SRV-ATTR:launch_index

Integer

参数解释：

批量创建场景，批创的所有弹性云服务器的启动顺序，范围为0到批量数量。

取值范围：

不涉及

OS-EXT-SRV-ATTR:kernel_id

String

参数解释：

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

取值范围：

不涉及

OS-EXT-SRV-ATTR:ramdisk_id

String

参数解释：

若使用AMI格式镜像，则表示ramdisk image的UUID；否则，留空。

取值范围：

不涉及

OS-EXT-SRV-ATTR:root_device_name

String

参数解释：

弹性云服务器系统盘的设备名称，例如当系统盘的磁盘模式是VBD，为/dev/vda，磁盘模式是SCSI，为/dev/sda。

取值范围：

不涉及

OS-EXT-SRV-ATTR:user_data

String

参数解释：

创建弹性云服务器时指定的user_data（编码过后的信息）。

取值范围：

不涉及

locked

Boolean

参数解释：

弹性云服务器是否为锁定状态。

取值范围：

  • true：锁定
  • false：未锁定

tags

Array of strings

参数解释：

弹性云服务器标签列表。

取值范围：

不涉及

os:scheduler_hints

Object

参数解释：

弹性云服务器调度信息，详情请参见表13 。

取值范围：

不涉及

enterprise_project_id

String

参数解释：

弹性云服务器所属的企业项目ID。

取值范围：

不涉及

sys_tags

Array of objects

参数解释：

弹性云服务器系统标签。

详情请参见表6。

取值范围：

不涉及

auto_terminate_time

String

参数解释：

云服务器定时删除时间。

说明：

如果云服务器未设置定时删除时间，返回为空。

包年/包月云服务器不支持设置定时删除时间，返回为空。

取值范围：

不涉及

cpu_options

Object

参数解释：

自定义CPU选项。

详情请参见表5。

取值范围：

不涉及

hypervisor

Object

参数解释：

扩展属性，虚拟化信息。

详情请参见 表6。

取值范围：

不涉及

network_interfaces

Array of objects

参数解释：

网络接口信息。

详情请参见表7。

取值范围：

不涉及
表4 addresses字段数据结构说明

参数

参数类型

描述

version

String

参数解释：

IP地址版本。

取值范围：

  • “4”：代表IPv4。
  • “6”：代表IPv6。

addr

String

参数解释：

IP地址。

取值范围：

不涉及

primary

Boolean

参数解释：

是否是主网卡。

取值范围：

  • true：主网卡。
  • false：辅助网卡。

OS-EXT-IPS:type

String

参数解释：

IP地址类型。

取值范围：

  • fixed：代表私有IP地址。
  • floating：代表浮动IP地址。

OS-EXT-IPS-MAC:mac_addr

String

参数解释：

MAC地址。

取值范围：

不涉及

OS-EXT-IPS:port_id

String

参数解释：

IP地址对应的端口ID。

取值范围：

不涉及
表5 cpu_options数据结构说明

参数

参数类型

描述

hw:cpu_threads

Integer

参数解释：

用于控制CPU是否开启超线程。

需要同时满足如下条件，才能设置为“关闭超线程”：

  • 只能在实例创建或者resize时指定。
  • 只有目标flavor的extra_specs参数：
    • 存在“hw:cpu_policy”并取值为“dedicated”。
    • 存在“hw:cpu_threads”并取值为“2”。

取值范围：

  • 1: 关闭超线程。
  • 2: 打开超线程。
表6 hypervisor数据结构说明

参数

参数类型

描述

hypervisor_type

String

参数解释：

虚拟化类型。

取值范围：

不涉及

csd_hypervisor

String

参数解释：

预留属性。

取值范围：

不涉及
表7 network_interface数据结构说明

参数

参数类型

描述

port_id

String

参数解释：

端口ID。

取值范围：

不涉及

primary

Boolean

参数解释：

是否为主网卡。

取值范围：

  • true：主网卡
  • false：扩展网卡

ip_addresses

Array of strings

参数解释：

私有IPv4地址。

取值范围：

不涉及

ipv6_addresses

Array of strings

参数解释：

私有IPv6地址。

取值范围：

不涉及

association

Object

参数解释：

关联的弹性公网IP信息。详情请参见表8。

取值范围：

不涉及

subnet_id

String

参数解释：

子网ID。

取值范围：

不涉及
表8 association字段数据结构说明

参数

参数类型

描述

public_ip_address

String

参数解释：

弹性公网IP地址，IPv4地址。

取值范围：

不涉及

请求示例

查询ID为“4f4b3dfa-eb70-47cf-a60a-998a53bd598a”的云服务器详情。

GET https://{endpoint}/v1/{project_id}/cloudservers/{server_id}

响应示例

{
    "server": {
        "id": "4f4b3dfa-eb70-47cf-a60a-998a53bd598a",
        "name": "ecs-2ecf",
        "addresses": {
            "0431c5e5-bc94-4a44-8263-15da2a642435": [
                {
                    "version": "4",
                    "addr": "192.168.1.99",
                    "primary": true,
                    "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:df:18:6d",
                    "OS-EXT-IPS:type": "fixed",
                    "OS-EXT-IPS:port_id": "23037c18-027a-44e5-b6b9-f8d8f113fe02"
                }
            ]
        },
        "flavor": {
            "disk": "0",
            "vcpus": "2",
            "ram": "1024",
            "id": "s3.large.1",
            "name": "s3.large.1",
            "gpus": [

            ],
            "asic_accelerators": [

            ]
        },
        "accessIPv4": "",
        "accessIPv6": "",
        "status": "ACTIVE",
        "progress": 0,
        "hostId": "c7145889b2e3202cd295ceddb1742ff8941b827b586861fd0acedf64",
        "updated": "2018-09-13T07:06:51Z",
        "created": "2018-09-13T07:03:44Z",
        "metadata": {
            "metering.order_id": "CS1809131459IGC24",
            "image_name": "Public_Cloudinit_Oracle_Linux_7.4_64bit_40G",
            "metering.resourcespeccode": "s3.large.1",
            "charging_mode": "1",
            "vpc_id": "0431c5e5-bc94-4a44-8263-15da2a642435",
            "os_type": "Linux",
            "metering.resourcetype": "1",
            "metering.image_id": "c71b64e7-4767-4406-afde-2c7c7ac2242c",
            "os_bit": "64",
            "__support_agent_list": "hss,ces",
            "cascaded.instance_extrainfo": "pcibridge:2",
            "metering.imagetype": "gold"
        },
        "tags": [

        ],
        "description": "",
        "locked": false,
        "config_drive": "",
        "tenant_id": "ff2eb406effc455aba53174463eb9322",
        "user_id": "0bc5e11f91dd48849bb03b7c8a263b2c",
        "key_name": "KeyPair-d750",
        "os-extended-volumes:volumes_attached": [
            {
                "id": "80c15cff-2473-4982-a816-d760cad6c42c",
                "delete_on_termination": "false",
                "device": "/dev/vda",
                "bootIndex": "0"
            }
        ],
        "OS-EXT-STS:task_state": null,
        "OS-EXT-STS:power_state": 1,
        "OS-EXT-STS:vm_state": "active",
        "OS-EXT-SRV-ATTR:host": "az21.dc1",
        "OS-EXT-SRV-ATTR:instance_name": "instance-0015147f",
        "OS-EXT-SRV-ATTR:hypervisor_hostname": "nova003@74",
        "OS-DCF:diskConfig": "MANUAL",
        "OS-EXT-AZ:availability_zone": "az1-dc1",
        "os:scheduler_hints": {

        },
        "OS-EXT-SRV-ATTR:root_device_name": "/dev/vda",
        "OS-EXT-SRV-ATTR:ramdisk_id": "",
        "enterprise_project_id": "0",
        "OS-EXT-SRV-ATTR:user_data": null,
        "enterprise_project_id":"0",
        "OS-SRV-USG:launched_at": "2018-09-13T07:04:09.197749",
        "OS-EXT-SRV-ATTR:kernel_id": "",
        "OS-EXT-SRV-ATTR:launch_index": 0,
        "host_status": "UP",
        "OS-EXT-SRV-ATTR:reservation_id": "r-nrd8b5c4",
        "OS-EXT-SRV-ATTR:hostname": "ecs-2ecf",
        "OS-SRV-USG:terminated_at": null,
        "sys_tags": [
            {
                "key": "_sys_enterprise_project_id",
                "value": "0"
            }
        ],
        "security_groups": [
            {
                "id": "6505b5d1-7837-41eb-8a1c-869d4355baa3",
                "name": "sg-95ec"
            }
        ],
        "image": {
            "id": "c71b64e7-4767-4406-afde-2c7c7ac2242c"
        },
        "hypervisor": null,
        "auto_terminate_time": "",
        "cpu_options": {
            "hw:cpu_threads": null
        },
        "enclave_options": {
            "enabled": false
        },
        "capacity_reservation_id": null,
        "capacity_reservation_specification": {
            "id": null,
            "preference": null
        },
        "spod_id": null
    }
}

返回值

请参考通用请求返回值。

错误码

请参考错误码。

父主题： 生命周期管理

相关文档