华为云计算 云知识 查询弹性云服务器详情列表ListServersDetails
查询弹性云服务器详情列表ListServersDetails

 

接口说明

根据用户请求条件从 数据库 筛选、查询所有的弹性 云服务器 ,并关联相关表获取到弹性云服务器的详细信息。

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

约束说明

URL
GET  https://ecs.cn-north-1.myhuaweicloud.com/v1/{project_id}/cloudservers/detail 
请求参数
名称 类型 IN 必选
X-Auth-Token
 
string header
project_id
 
string path
enterprise_project_id
 
string query
flavor
 
string query
ip
 
string query
limit
 
integer query
name
 
string query
not-tags
 
string query
offset
 
integer query
reservation_id
 
string query
status
 
string query
tags
 
string query
ip_eq
 
string query
server_id
 
string query
返回参数
返回码: 200

OK

名称 类型 必选 描述
count
 
integer

弹性云服务器的列表总数。

servers
 
Array of ServerDetail objects

弹性云服务器详情列表,具体参照-查询云服务器详情接口。查询级别不同,返回的详情不同。

200 servers
名称 类型 必选 描述
status
 
string

弹性云服务器状态。

取值范围:

ACTIVE、BUILD、DELETED、ERROR、HARD_REBOOT、MIGRATING、PAUSED、REBOOT、REBUILD、RESIZE、REVERT_RESIZE、SHUTOFF、SHELVED、SHELVED_OFFLOADED、SOFT_DELETED、SUSPENDED、VERIFY_RESIZE

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

updated
 
string

弹性云服务器更新时间。

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

auto_terminate_time
 
string

弹性云服务器自动释放时间。

时间格式例如:2020-01-19T03:30:52Z

hostId
 
string

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

OS-EXT-SRV-ATTR:host
 
string

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

addresses
 
Map<String,Array<Object>>

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

key_name
 
string

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

image
 
ServerImage object

弹性云服务器 镜像 信息。

OS-EXT-STS:task_state
 
string

扩展属性,弹性云服务器当前任务的状态。

取值范围请参考云服务器状态表3。

OS-EXT-STS:vm_state
 
string

扩展属性,弹性云服务器当前状态。

云服务器状态说明请参考云服务器状态

OS-EXT-SRV-ATTR:instance_name
 
string

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

OS-EXT-SRV-ATTR:hypervisor_hostname
 
string

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

flavor
 
ServerFlavor object

弹性云服务器规格信息。

id
 
string

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

security_groups
 
Array of ServerSecurityGroup objects

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

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
 
ServerFault object

弹性云服务器故障信息。

可选参数,在弹性云服务器状态为ERROR且存在异常的情况下返回。

progress
 
integer

弹性云服务器进度。

OS-EXT-STS:power_state
 
integer

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

config_drive
 
string

config drive信息。

metadata
 
Map<String,String>

弹性云服务器元数据。

说明:

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

系统默认添加字段

  1. charging_mode 云服务器的计费类型。
  • “0”:按需计费(即postPaid-后付费方式)。
  • “1”:按包年包月计费(即prePaid-预付费方式)。"2":竞价实例计费
  1. metering.order_id 按“包年/包月”计费的云服务器对应的订单ID。

  2. metering.product_id 按“包年/包月”计费的云服务器对应的产品ID。

  3. vpc_id 云服务器所属的 虚拟私有云 ID。

  4. EcmResStatus 云服务器的冻结状态。

  • normal:云服务器正常状态(未被冻结)。
  • freeze:云服务器被冻结。

当云服务器被冻结或者解冻后,系统默认添加该字段,且该字段必选。

  1. metering.image_id 云服务器操作系统对应的镜像ID

  2. metering.imagetype 镜像类型,目前支持:

  • 公共镜像(gold)
  • 私有镜像(private)
  • 共享镜像(shared)
  1. metering.resourcespeccode 云服务器对应的资源规格。

  2. image_name 云服务器操作系统对应的镜像名称。

  3. os_bit 操作系统位数,一般取值为“32”或者“64”。

  4. lockCheckEndpoint 回调URL,用于检查弹性云服务器的加锁是否有效。

  • 如果有效,则云服务器保持锁定状态。
  • 如果无效,解除锁定状态,删除失效的锁。
  1. lockSource 弹性云服务器来自哪个服务。订单加锁(ORDER)

  2. lockSourceId 弹性云服务器的加锁来自哪个ID。lockSource为“ORDER”时,lockSourceId为订单ID。

  3. lockScene 弹性云服务器的加锁类型。

  • 按需转包周期(TO_PERIOD_LOCK)
  1. virtual_env_type
  • IOS镜像创建虚拟机,"virtual_env_type": "IsoImage" 属性;
  • 非IOS镜像创建虚拟机,在19.5.0版本以后创建的虚拟机将不会添加virtual_env_type 属性,而在此之前的版本创建的虚拟机可能会返回"virtual_env_type": "FusionCompute"属性 。

virtual_env_type属性不允许用户增加、删除和修改。

  1. metering.resourcetype 云服务器对应的资源类型。

  2. os_type 操作系统类型,取值为:Linux、Windows。

  3. cascaded.instance_extrainfo 系统内部虚拟机扩展信息。

  4. __support_agent_list 云服务器是否支持 企业主机安全 、主机监控。

  1. agency_name 委托的名称。

委托是由租户管理员在 统一身份认证 服务(Identity and Access Management, IAM )上创建的,可以为弹性云服务器提供访问云服务的临时凭证。

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 ServerExtendVolumeAttachment objects

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

description
 
string

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

host_status
 
string

nova-compute状态。

  • UP:服务正常
  • UNKNOWN:状态未知
  • DOWN:服务异常
  • MAINTENANCE:维护状态
  • 空字符串:弹性云服务器无主机信息
OS-EXT-SRV-ATTR:hostname
 
string

弹性云服务器的主机名。

OS-EXT-SRV-ATTR:reservation_id
 
string

批量创建场景,弹性云服务器的预留ID。

OS-EXT-SRV-ATTR:launch_index
 
integer

批量创建场景,弹性云服务器的启动顺序。

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

弹性云服务器系统盘的设备名称。

OS-EXT-SRV-ATTR:user_data
 
string

创建弹性云服务器时指定的user_data。

locked
 
boolean

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

  • true:锁定
  • false:未锁定
tags
 
Array of strings

弹性云服务器标签。

os:scheduler_hints
 
ServerSchedulerHints object

弹性云服务器调度信息

enterprise_project_id
 
string

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

sys_tags
 
Array of ServerSystemTag objects

弹性云服务器系统标签。

cpu_options
 
CpuOptions object

自定义CPU选项。

hypervisor
 
Hypervisor object

hypervisor信息。

200 servers.addresses: Map<String,Array<Object>>
名称 类型 必选 描述
version
 
string

IP地址版本。

  • “4”:代表IPv4。
  • “6”:代表IPv6。
addr
 
string

IP地址。

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。

200 servers.image
名称 类型 必选 描述
id
 
string

镜像id

200 servers.flavor
名称 类型 必选 描述
id
 
string

弹性云服务器规格ID。

name
 
string

弹性云服务器规格名称。

disk
 
string

该云服务器规格对应要求系统盘大小,0为不限制。此字段在本系统中无效。

vcpus
 
string

该云服务器规格对应的CPU核数。

ram
 
string

该云服务器规格对应的内存大小,单位为MB。

200 servers.security_groups
名称 类型 必选 描述
name
 
string

安全组名称或者UUID。

id
 
string

安全组ID。

200 servers.fault
名称 类型 必选 描述
code
 
integer

错误码。

created
 
string

异常出现的时间。

message
 
string

异常描述信息。

details
 
string

异常详情信息。

200 servers.os-extended-volumes:volumes_attached
名称 类型 必选 描述
id
 
string

磁盘ID,格式为UUID。

delete_on_termination
 
string

删弹性云服务器时是否一并删除该磁盘。

  • true:是
  • false:否 微版本2.3及以上版本支持。
bootIndex
 
string

启动标识,“0”代表启动盘,“-1“代表非启动盘。

device
 
string

云硬盘 挂载盘符,即磁盘挂载点。

200 servers.os:scheduler_hints
名称 类型 必选 描述
group
 
Array of strings

反亲和性组信息。

UUID格式。

tenancy
 
Array of strings

专属主机 或共享池中创建弹性云服务器。默认为在共享池创建。值为: shared或dedicated。

  • shared:表示共享池。
  • dedicated:表示专属主机。

创建与查询此值均有效。

dedicated_host_id
 
Array of strings

专属主机ID。

此属性仅在tenancy值为dedicated时有效。

不指定此属性,系统将自动分配租户可自动放置弹性云服务器的专属主机。

创建与查询此值均有效。

200 servers.sys_tags
名称 类型 必选 描述
key
 
string

系统标签的Key值。

value
 
string

系统标签的value值。

200 servers.cpu_options
名称 类型 必选 描述
hw:cpu_threads
 
integer

CPU超线程数, 决定CPU是否开启超线程

200 servers.hypervisor
名称 类型 必选 描述
hypervisor_type
 
string

hypervisor类型

csd_hypervisor
 
string

hypervisor csd信息

请求示例
示例 1
 
"GET https://{endpoint}/v1/{project_id}/cloudservers/detail"
返回示例
返回码:200

OK

示例 1
 
{
"count": 5,
"servers": [
{
"id": "9f819649-1f7c-44ea-a315-7aa6706de50b",
"name": "ecs-test01",
"addresses": {
"0dae26c9-9a70-4392-93f3-87d53115d171": [
{
"version": "4",
"addr": "192.168.0.116"
}
]
},
"flavor": {
"disk": "0",
"vcpus": "4",
"ram": "4096",
"id": "c1.xlarge",
"name": "c1.xlarge"
},
"accessIPv4": "",
"accessIPv6": "",
"status": "ACTIVE",
"progress": 0,
"hostId": "309fc3c650ff6a1c9b20b975315f531814c3a512d8f3f5ffabb076fc",
"updated": "2018-06-19T07:49:49Z",
"created": "2018-06-19T07:44:24Z",
"metadata": {
"metering.image_id": "af60e0d5-6952-4f3d-b0ed-31bb19d4a692",
"metering.imagetype": "gold",
"metering.resourcespeccode": "c1.xlarge.linux",
"image_name": "HEC_Public_Cloudinit_CentOS_7.4_64bit",
"os_bit": "64",
"vpc_id": "0dae26c9-9a70-4392-93f3-87d53115d171",
"os_type": "Linux",
"charging_mode": "0"
},
"tags": [],
"description": "ecs-test01",
"locked": false,
"config_drive": "",
"tenant_id": "13c67a214ced4afb88d911ae4bd56666",
"user_id": "71dff1b123b54093a00af1cb98c76666",
"key_name": "KeyPair-3e89",
"OS-EXT-STS:power_state": 1,
"OS-EXT-STS:vm_state": "active",
"OS-EXT-SRV-ATTR:host": "az1.dc1",
"OS-EXT-SRV-ATTR:instance_name": "instance-000ffcfa",
"OS-EXT-SRV-ATTR:hypervisor_hostname": "nova001@248",
"OS-DCF:diskConfig": "MANUAL",
"OS-EXT-AZ:availability_zone": "az1.dc1",
"os:scheduler_hints": {},
"OS-EXT-SRV-ATTR:root_device_name": "/dev/sda",
"OS-EXT-SRV-ATTR:ramdisk_id": "",
"enterprise_project_id": "0",
"OS-SRV-USG:launched_at": "2018-06-19T07:47:17.173337",
"OS-EXT-SRV-ATTR:kernel_id": "",
"OS-EXT-SRV-ATTR:launch_index": 0,
"host_status": "UP",
"OS-EXT-SRV-ATTR:reservation_id": "r-luu05mkl",
"OS-EXT-SRV-ATTR:hostname": "ecs-test"
},
{
"id": "c93a6639-5ca5-484f-9d1e-3c9a645c8286",
"name": "ecs-5471",
"addresses": {
"0dae26c9-9a70-4392-93f3-87d53115d171": [
{
"version": "4",
"addr": "192.168.0.243"
}
]
},
"flavor": {
"disk": "0",
"vcpus": "1",
"ram": "1024",
"id": "s2.small.1",
"name": "s2.small.1"
},
"accessIPv4": "",
"accessIPv6": "",
"status": "ACTIVE",
"progress": 0,
"hostId": "309fc3c650ff6a1c9b20b975315f531814c3a512d8f3f5ffabb076fc",
"updated": "2018-06-15T08:59:37Z",
"created": "2018-06-15T08:56:24Z",
"metadata": {
"metering.order_id": "CS1806151652ACIDD",
"metering.image_id": "af60e0d5-6952-4f3d-b0ed-31bb19d4a692",
"metering.imagetype": "gold",
"metering.resourcespeccode": "s2.small.1.linux",
"image_name": "HEC_Public_Cloudinit_CentOS_7.4_64bit",
"metering.product_id": "00301-184015-0--0",
"os_bit": "64",
"vpc_id": "0dae26c9-9a70-4392-93f3-87d53115d171",
"os_type": "Linux",
"charging_mode": "1"
},
"tags": [],
"description": "ecs-5471",
"locked": false,
"config_drive": "",
"tenant_id": "13c67a214ced4afb88d911ae4bd56666",
"user_id": "7ab967cfe70d4bada0b5d4aaadc46666",
"key_name": "KeyPair-3e89",
"OS-EXT-STS:power_state": 1,
"OS-EXT-STS:vm_state": "active",
"OS-EXT-SRV-ATTR:host": "az1.dc1",
"OS-EXT-SRV-ATTR:instance_name": "instance-000ff19f",
"OS-EXT-SRV-ATTR:hypervisor_hostname": "nova001@248",
"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-SRV-USG:launched_at": "2018-06-15T08:56:59.017321",
"OS-EXT-SRV-ATTR:kernel_id": "",
"OS-EXT-SRV-ATTR:launch_index": 0,
"host_status": "UP",
"OS-EXT-SRV-ATTR:reservation_id": "r-3my5zkz1",
"OS-EXT-SRV-ATTR:hostname": "ecs-5471",
"auto_terminate_time": 1610494442000
}
]
}
SDK
点击 弹性云服务器 (ECS) SDK, 下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
错误码
请参考 错误码说明
上一篇:查询资源实例ShowResInstanceInfo 下一篇:云日志服务500M免费额度怎么算

弹性云服务器 ECS

 

弹性云服务器(Elastic Cloud Server)是一种可随时自助获取、可弹性伸缩的云服务器,帮助用户打造可靠、安全、灵活、高效的应用环境,确保服务持久稳定运行,提升运维效率