華為云計算 云知識 查詢彈性云服務(wù)器詳情列表ListServersDetails
查詢彈性云服務(wù)器詳情列表ListServersDetails
時間: 2023-07-24 10:30:02
猜你想看：
實時語音識別 云服務(wù)器配置 CDN是什么意思 視頻點播加速 什么是云桌面

 

接口說明

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

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

約束說明

無

URL
GET  https://ecs.cn-north-1.myhuaweicloud.com/v1/{project_id}/cloudservers/detail 
請求參數(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ù)器詳情列表,具體參照-查詢云服務(wù)器詳情接口。查詢級別不同,返回的詳情不同。
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)說明請參考云服務(wù)器狀態(tài)
updated
 
 string 是

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

時間格式例如:2019-05-22T03:30:52Z
auto_terminate_time
 
 string 是

彈性云服務(wù)器自動釋放時間。

時間格式例如:2020-01-19T03:30:52Z
hostId
 
 string 是

彈性云服務(wù)器所在主機的主機ID。
OS-EXT-SRV-ATTR:host
 
 string 是

彈性云服務(wù)器所在主機的主機名稱。
addresses
 
 Map<String,Array<Object>> 是

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

彈性云服務(wù)器使用的密鑰對名稱。
image
 
 ServerImage object 是

彈性云服務(wù)器 鏡像 信息。
OS-EXT-STS:task_state
 
 string 是

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

取值范圍請參考云服務(wù)器狀態(tài)表3。
OS-EXT-STS:vm_state
 
 string 是

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

云服務(wù)器狀態(tài)說明請參考云服務(wù)器狀態(tài)。
OS-EXT-SRV-ATTR:instance_name
 
 string 是

擴展屬性,彈性云服務(wù)器別名。
OS-EXT-SRV-ATTR:hypervisor_hostname
 
 string 是

擴展屬性,彈性云服務(wù)器所在虛擬化主機名。
flavor
 
 ServerFlavor object 是

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

彈性云服務(wù)器ID,格式為UUID。
security_groups
 
 Array of ServerSecurityGroup objects 是

彈性云服務(wù)器所屬安全組列表。
OS-EXT-AZ:availability_zone
 
 string 是

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

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

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

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

時間格式例如:2019-05-22T03:19:19Z
tenant_id
 
 string 是

彈性云服務(wù)器所屬租戶ID,即項目id,和project_id表示相同的概念,格式為UUID。
OS-DCF:diskConfig
 
 string 否

擴展屬性, diskConfig的類型。

  • MANUAL,鏡像空間不會擴展。
  • AUTO,系統(tǒng)盤鏡像空間會自動擴展為與flavor大小一致。
accessIPv4
 
 string 是

預(yù)留屬性。
accessIPv6
 
 string 是

預(yù)留屬性。
fault
 
 ServerFault object 否

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

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

彈性云服務(wù)器進度。
OS-EXT-STS:power_state
 
 integer 是

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

config drive信息。
metadata
 
 Map<String,String> 是

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

說明:

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

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

  1. charging_mode 云服務(wù)器的計費類型。
  • “0”:按需計費(即postPaid-后付費方式)。
  • “1”:按包年包月計費(即prePaid-預(yù)付費方式)。"2":競價實例計費

  1. metering.order_id 按“包年/包月”計費的云服務(wù)器對應(yīng)的訂單ID。

  2. metering.product_id 按“包年/包月”計費的云服務(wù)器對應(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)對應(yīng)的鏡像ID

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

  • 公共鏡像(gold)
  • 私有鏡像(private)
  • 共享鏡像(shared)

  1. metering.resourcespeccode 云服務(wù)器對應(yīng)的資源規(guī)格。

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

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

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

  • 如果有效,則云服務(wù)器保持鎖定狀態(tài)。
  • 如果無效,解除鎖定狀態(tài),刪除失效的鎖。

  1. lockSource 彈性云服務(wù)器來自哪個服務(wù)。訂單加鎖(ORDER)

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

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

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

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

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

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

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

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

  1. agency_name 委托的名稱。

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

彈性云服務(wù)器啟動時間。時間格式例如:2019-05-22T03:23:59.000000
OS-SRV-USG:terminated_at
 
 string 是

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

時間格式例如:2019-05-22T03:23:59.000000
os-extended-volumes:volumes_attached
 
 Array of ServerExtendVolumeAttachment objects 是

掛載到彈性云服務(wù)器上的磁盤。
description
 
 string 否

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

nova-compute狀態(tài)。

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

彈性云服務(wù)器的主機名。
OS-EXT-SRV-ATTR:reservation_id
 
 string 否

批量創(chuàng)建場景,彈性云服務(wù)器的預(yù)留ID。
OS-EXT-SRV-ATTR:launch_index
 
 integer 是

批量創(chuàng)建場景,彈性云服務(wù)器的啟動順序。
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)盤的設(shè)備名稱。
OS-EXT-SRV-ATTR:user_data
 
 string 否

創(chuàng)建彈性云服務(wù)器時指定的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è)項目ID。
sys_tags
 
 Array of ServerSystemTag objects 否

彈性云服務(wù)器系統(tǒng)標(biāo)簽。
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地址對應(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ī)格對應(yīng)要求系統(tǒng)盤大小,0為不限制。此字段在本系統(tǒng)中無效。
vcpus
 
 string 是

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

該云服務(wù)器規(guī)格對應(yīng)的內(nèi)存大小,單位為MB。
200 servers.security_groups
名稱 類型 必選 描述
name
 
 string 是

安全組名稱或者UUID。
id
 
 string 是

安全組ID。
200 servers.fault
名稱 類型 必選 描述
code
 
 integer 否

錯誤碼。
created
 
 string 否

異常出現(xiàn)的時間。
message
 
 string 否

異常描述信息。
details
 
 string 否

異常詳情信息。
200 servers.os-extended-volumes:volumes_attached
名稱 類型 必選 描述
id
 
 string 是

磁盤ID,格式為UUID。
delete_on_termination
 
 string 是

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

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

啟動標(biāo)識,“0”代表啟動盤,“-1“代表非啟動盤。
device
 
 string 是

云硬盤 掛載盤符,即磁盤掛載點。
200 servers.os:scheduler_hints
名稱 類型 必選 描述
group
 
 Array of strings 否

反親和性組信息。

UUID格式。
tenancy
 
 Array of strings 否

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

  • shared:表示共享池。
  • dedicated:表示專屬主機。

創(chuàng)建與查詢此值均有效。
dedicated_host_id
 
 Array of strings 否

專屬主機ID。

此屬性僅在tenancy值為dedicated時有效。

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

創(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是否開啟超線程
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
點擊 彈性云服務(wù)器 (ECS) SDK, 下載SDK或查看SDK文檔。SDK的安裝、認(rèn)證方式等在SDK文檔中對應(yīng)語言類型的【使用】目錄下。
錯誤碼
請參考 錯誤碼說明。
查詢彈性云服務(wù)器詳情列表ListServersDetails

意見反饋

0/200

提交 取消

提交成功！非常感謝您的反饋，我們會繼續(xù)努力做到更好 反饋提交失敗！請稍后重試！