華為云計(jì)算 云知識(shí) 查詢彈性云服務(wù)器詳情列表ListServersDetails
查詢彈性云服務(wù)器詳情列表ListServersDetails

 

接口說(shuō)明

根據(jù)用戶請(qǐng)求條件從 數(shù)據(jù)庫(kù) 篩選、查詢所有的彈性 云服務(wù)器 ,并關(guān)聯(lián)相關(guān)表獲取到彈性云服務(wù)器的詳細(xì)信息。

該接口支持查詢彈性云服務(wù)器計(jì)費(fèi)方式,以及是否被凍結(jié)。

約束說(shuō)明

無(wú)

URL
GET  https://ecs.cn-north-1.myhuaweicloud.com/v1/{project_id}/cloudservers/detail 
請(qǐng)求參數(shù)
名稱 類型 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
返回參數(shù)
返回碼: 200

OK

名稱 類型 必選 描述
count
 
integer

彈性云服務(wù)器的列表總數(shù)。

servers
 
Array of ServerDetail objects

彈性云服務(wù)器詳情列表,具體參照-查詢?cè)品?wù)器詳情接口。查詢級(jí)別不同,返回的詳情不同。

200 servers
名稱 類型 必選 描述
status
 
string

彈性云服務(wù)器狀態(tài)。

取值范圍:

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

彈性云服務(wù)器狀態(tài)說(shuō)明請(qǐng)參考云服務(wù)器狀態(tài)

updated
 
string

彈性云服務(wù)器更新時(shí)間。

時(shí)間格式例如:2019-05-22T03:30:52Z

auto_terminate_time
 
string

彈性云服務(wù)器自動(dòng)釋放時(shí)間。

時(shí)間格式例如:2020-01-19T03:30:52Z

hostId
 
string

彈性云服務(wù)器所在主機(jī)的主機(jī)ID。

OS-EXT-SRV-ATTR:host
 
string

彈性云服務(wù)器所在主機(jī)的主機(jī)名稱。

addresses
 
Map<String,Array<Object>>

彈性云服務(wù)器的網(wǎng)絡(luò)屬性。

key_name
 
string

彈性云服務(wù)器使用的密鑰對(duì)名稱。

image
 
ServerImage object

彈性云服務(wù)器 鏡像 信息。

OS-EXT-STS:task_state
 
string

擴(kuò)展屬性,彈性云服務(wù)器當(dāng)前任務(wù)的狀態(tài)。

取值范圍請(qǐng)參考云服務(wù)器狀態(tài)表3。

OS-EXT-STS:vm_state
 
string

擴(kuò)展屬性,彈性云服務(wù)器當(dāng)前狀態(tài)。

云服務(wù)器狀態(tài)說(shuō)明請(qǐng)參考云服務(wù)器狀態(tài)。

OS-EXT-SRV-ATTR:instance_name
 
string

擴(kuò)展屬性,彈性云服務(wù)器別名。

OS-EXT-SRV-ATTR:hypervisor_hostname
 
string

擴(kuò)展屬性,彈性云服務(wù)器所在虛擬化主機(jī)名。

flavor
 
ServerFlavor object

彈性云服務(wù)器規(guī)格信息。

id
 
string

彈性云服務(wù)器ID,格式為UUID。

security_groups
 
Array of ServerSecurityGroup objects

彈性云服務(wù)器所屬安全組列表。

OS-EXT-AZ:availability_zone
 
string

擴(kuò)展屬性,彈性云服務(wù)器所在可用區(qū)名稱。

user_id
 
string

創(chuàng)建彈性云服務(wù)器的用戶ID,格式為UUID。

name
 
string

彈性云服務(wù)器名稱。

created
 
string

彈性云服務(wù)器創(chuàng)建時(shí)間。

時(shí)間格式例如:2019-05-22T03:19:19Z

tenant_id
 
string

彈性云服務(wù)器所屬租戶ID,即項(xiàng)目id,和project_id表示相同的概念,格式為UUID。

OS-DCF:diskConfig
 
string

擴(kuò)展屬性, diskConfig的類型。

  • MANUAL,鏡像空間不會(huì)擴(kuò)展。
  • AUTO,系統(tǒng)盤(pán)鏡像空間會(huì)自動(dòng)擴(kuò)展為與flavor大小一致。
accessIPv4
 
string

預(yù)留屬性。

accessIPv6
 
string

預(yù)留屬性。

fault
 
ServerFault object

彈性云服務(wù)器故障信息。

可選參數(shù),在彈性云服務(wù)器狀態(tài)為ERROR且存在異常的情況下返回。

progress
 
integer

彈性云服務(wù)器進(jìn)度。

OS-EXT-STS:power_state
 
integer

擴(kuò)展屬性,彈性云服務(wù)器電源狀態(tài)。

config_drive
 
string

config drive信息。

metadata
 
Map<String,String>

彈性云服務(wù)器元數(shù)據(jù)。

說(shuō)明:

元數(shù)據(jù)包含系統(tǒng)默認(rèn)添加字段和用戶設(shè)置的字段。

系統(tǒng)默認(rèn)添加字段

  1. charging_mode 云服務(wù)器的計(jì)費(fèi)類型。
  • “0”:按需計(jì)費(fèi)(即postPaid-后付費(fèi)方式)。
  • “1”:按包年包月計(jì)費(fèi)(即prePaid-預(yù)付費(fèi)方式)。"2":競(jìng)價(jià)實(shí)例計(jì)費(fèi)
  1. metering.order_id 按“包年/包月”計(jì)費(fèi)的云服務(wù)器對(duì)應(yīng)的訂單ID。

  2. metering.product_id 按“包年/包月”計(jì)費(fèi)的云服務(wù)器對(duì)應(yīng)的產(chǎn)品ID。

  3. vpc_id 云服務(wù)器所屬的 虛擬私有云 ID。

  4. EcmResStatus 云服務(wù)器的凍結(jié)狀態(tài)。

  • normal:云服務(wù)器正常狀態(tài)(未被凍結(jié))。
  • freeze:云服務(wù)器被凍結(jié)。

當(dāng)云服務(wù)器被凍結(jié)或者解凍后,系統(tǒng)默認(rèn)添加該字段,且該字段必選。

  1. metering.image_id 云服務(wù)器操作系統(tǒng)對(duì)應(yīng)的鏡像ID

  2. metering.imagetype 鏡像類型,目前支持:

  • 公共鏡像(gold)
  • 私有鏡像(private)
  • 共享鏡像(shared)
  1. metering.resourcespeccode 云服務(wù)器對(duì)應(yīng)的資源規(guī)格。

  2. image_name 云服務(wù)器操作系統(tǒng)對(duì)應(yīng)的鏡像名稱。

  3. os_bit 操作系統(tǒng)位數(shù),一般取值為“32”或者“64”。

  4. lockCheckEndpoint 回調(diào)URL,用于檢查彈性云服務(wù)器的加鎖是否有效。

  • 如果有效,則云服務(wù)器保持鎖定狀態(tài)。
  • 如果無(wú)效,解除鎖定狀態(tài),刪除失效的鎖。
  1. lockSource 彈性云服務(wù)器來(lái)自哪個(gè)服務(wù)。訂單加鎖(ORDER)

  2. lockSourceId 彈性云服務(wù)器的加鎖來(lái)自哪個(gè)ID。lockSource為“ORDER”時(shí),lockSourceId為訂單ID。

  3. lockScene 彈性云服務(wù)器的加鎖類型。

  • 按需轉(zhuǎn)包周期(TO_PERIOD_LOCK)
  1. virtual_env_type
  • IOS鏡像創(chuàng)建虛擬機(jī),"virtual_env_type": "IsoImage" 屬性;
  • 非IOS鏡像創(chuàng)建虛擬機(jī),在19.5.0版本以后創(chuàng)建的虛擬機(jī)將不會(huì)添加virtual_env_type 屬性,而在此之前的版本創(chuàng)建的虛擬機(jī)可能會(huì)返回"virtual_env_type": "FusionCompute"屬性 。

virtual_env_type屬性不允許用戶增加、刪除和修改。

  1. metering.resourcetype 云服務(wù)器對(duì)應(yīng)的資源類型。

  2. os_type 操作系統(tǒng)類型,取值為:Linux、Windows。

  3. cas cad ed.instance_extrainfo 系統(tǒng)內(nèi)部虛擬機(jī)擴(kuò)展信息。

  4. __support_agent_list 云服務(wù)器是否支持 企業(yè)主機(jī)安全 、主機(jī)監(jiān)控。

  1. agency_name 委托的名稱。

委托是由租戶管理員在 統(tǒng)一身份認(rèn)證 服務(wù)(Identity and Access Management, IAM )上創(chuàng)建的,可以為彈性云服務(wù)器提供訪問(wèn)云服務(wù)的臨時(shí)憑證。

OS-SRV-USG:launched_at
 
string

彈性云服務(wù)器啟動(dòng)時(shí)間。時(shí)間格式例如:2019-05-22T03:23:59.000000

OS-SRV-USG:terminated_at
 
string

彈性云服務(wù)器刪除時(shí)間。

時(shí)間格式例如:2019-05-22T03:23:59.000000

os-extended-volumes:volumes_attached
 
Array of ServerExtendVolumeAttachment objects

掛載到彈性云服務(wù)器上的磁盤(pán)。

description
 
string

彈性云服務(wù)器的描述信息。

host_status
 
string

nova-compute狀態(tài)。

  • UP:服務(wù)正常
  • UNKNOWN:狀態(tài)未知
  • DOWN:服務(wù)異常
  • MAINTENANCE:維護(hù)狀態(tài)
  • 空字符串:彈性云服務(wù)器無(wú)主機(jī)信息
OS-EXT-SRV-ATTR:hostname
 
string

彈性云服務(wù)器的主機(jī)名。

OS-EXT-SRV-ATTR:reservation_id
 
string

批量創(chuàng)建場(chǎng)景,彈性云服務(wù)器的預(yù)留ID。

OS-EXT-SRV-ATTR:launch_index
 
integer

批量創(chuàng)建場(chǎng)景,彈性云服務(wù)器的啟動(dòng)順序。

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

彈性云服務(wù)器系統(tǒng)盤(pán)的設(shè)備名稱。

OS-EXT-SRV-ATTR:user_data
 
string

創(chuàng)建彈性云服務(wù)器時(shí)指定的user_data。

locked
 
boolean

彈性云服務(wù)器是否為鎖定狀態(tài)。

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

彈性云服務(wù)器標(biāo)簽。

os:scheduler_hints
 
ServerSchedulerHints object

彈性云服務(wù)器調(diào)度信息

enterprise_project_id
 
string

彈性云服務(wù)器所屬的企業(yè)項(xiàng)目ID。

sys_tags
 
Array of ServerSystemTag objects

彈性云服務(wù)器系統(tǒng)標(biāo)簽。

cpu_options
 
CpuOptions object

自定義CPU選項(xiàng)。

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:代表浮動(dòng)IP地址。
OS-EXT-IPS-MAC:mac_addr
 
string

MAC地址。

OS-EXT-IPS:port_id
 
string

IP地址對(duì)應(yīng)的端口ID。

200 servers.image
名稱 類型 必選 描述
id
 
string

鏡像id

200 servers.flavor
名稱 類型 必選 描述
id
 
string

彈性云服務(wù)器規(guī)格ID。

name
 
string

彈性云服務(wù)器規(guī)格名稱。

disk
 
string

該云服務(wù)器規(guī)格對(duì)應(yīng)要求系統(tǒng)盤(pán)大小,0為不限制。此字段在本系統(tǒng)中無(wú)效。

vcpus
 
string

該云服務(wù)器規(guī)格對(duì)應(yīng)的CPU核數(shù)。

ram
 
string

該云服務(wù)器規(guī)格對(duì)應(yīng)的內(nèi)存大小,單位為MB。

200 servers.security_groups
名稱 類型 必選 描述
name
 
string

安全組名稱或者UUID。

id
 
string

安全組ID。

200 servers.fault
名稱 類型 必選 描述
code
 
integer

錯(cuò)誤碼。

created
 
string

異常出現(xiàn)的時(shí)間。

message
 
string

異常描述信息。

details
 
string

異常詳情信息。

200 servers.os-extended-volumes:volumes_attached
名稱 類型 必選 描述
id
 
string

磁盤(pán)ID,格式為UUID。

delete_on_termination
 
string

刪彈性云服務(wù)器時(shí)是否一并刪除該磁盤(pán)。

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

啟動(dòng)標(biāo)識(shí),“0”代表啟動(dòng)盤(pán),“-1“代表非啟動(dòng)盤(pán)。

device
 
string

云硬盤(pán) 掛載盤(pán)符,即磁盤(pán)掛載點(diǎn)。

200 servers.os:scheduler_hints
名稱 類型 必選 描述
group
 
Array of strings

反親和性組信息。

UUID格式。

tenancy
 
Array of strings

專屬主機(jī) 或共享池中創(chuàng)建彈性云服務(wù)器。默認(rèn)為在共享池創(chuàng)建。值為: shared或dedicated。

  • shared:表示共享池。
  • dedicated:表示專屬主機(jī)。

創(chuàng)建與查詢此值均有效。

dedicated_host_id
 
Array of strings

專屬主機(jī)ID。

此屬性僅在tenancy值為dedicated時(shí)有效。

不指定此屬性,系統(tǒng)將自動(dòng)分配租戶可自動(dòng)放置彈性云服務(wù)器的專屬主機(jī)。

創(chuàng)建與查詢此值均有效。

200 servers.sys_tags
名稱 類型 必選 描述
key
 
string

系統(tǒng)標(biāo)簽的Key值。

value
 
string

系統(tǒng)標(biāo)簽的value值。

200 servers.cpu_options
名稱 類型 必選 描述
hw:cpu_threads
 
integer

CPU超線程數(shù), 決定CPU是否開(kāi)啟超線程

200 servers.hypervisor
名稱 類型 必選 描述
hypervisor_type
 
string

hypervisor類型

csd_hypervisor
 
string

hypervisor csd信息

請(qǐng)求示例
示例 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
點(diǎn)擊 彈性云服務(wù)器 (ECS) SDK, 下載SDK或查看SDK文檔。SDK的安裝、認(rèn)證方式等在SDK文檔中對(duì)應(yīng)語(yǔ)言類型的【使用】目錄下。
錯(cuò)誤碼
請(qǐng)參考 錯(cuò)誤碼說(shuō)明。