更新时间:2025-03-07 gmt 08:00

查询云服务器详情-九游平台

功能介绍

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

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

调试

您可以在中调试该接口。

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

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

  • 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

预留属性。

fault

object

弹性云服务器故障原因。

  • 弹性云服务器状态正常时,返回null。
  • 弹性云服务器状态异常时,返回故障描述信息或故障详情:
    • message:故障信息
    • code:故障代码
    • details:故障详情
    • created:故障时间,iso8601格式

progress

integer

弹性云服务器进度,范围为0到100。

os-ext-sts:power_state

integer

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

取值范围:

  • 0:nostate
  • 1:running
  • 4:shutdown

config_drive

string

config drive信息。

metadata

map

弹性云服务器元数据。详情请参见表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

弹性云服务器系统盘的设备名称,例如当系统盘的磁盘模式是vdb,为/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

表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是否开启超线程。

取值范围:1,2。

  • 1: 关闭超线程。
  • 2: 打开超线程。

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

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

参数

参数类型

描述

hypervisor_type

string

虚拟化类型。

csd_hypervisor

string

预留属性。

请求示例

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

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

响应示例

{
    "server": {
        "fault": null,
        "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
        },
        "security_options": {
            "secure_boot_enabled": null,
            "tpm_enabled": null
        },
        "spod_id": null
    }
}

返回值

请参考通用请求返回值

错误码

请参考错误码

相关文档

网站地图