接口说明
本接口用于查询所有云主机的详细信息，但不包含云主机有关的网络信息。
URL
GET https://ecloud.10086.cn/api/openapi-console-web/v3/server/without/network
请求参数
Query
|
参数名称
|
类型
|
必填
|
描述
|
|
ecStatus
|
<enum(ACTIVE,BUILD,REBUILD,RESCUE,SUSPENDED,PAUSED,RESIZE,VERIFY_RESIZE,REVERT_RESIZE,PASSWORD,REBOOT,HARD_REBOOT,DELETED,ERROR,STOPPED,SHUTOFF,MIGRATING,UNRECOGNIZED)> array(multi)
|
否
|
云主机底层状态，1:ACTIVE (运行中)，2:BUILD(创建中)，3:REBUILD(重装中)，4:SUSPENDED(休眠中)，5:PAUSED(已暂停)，6:RESIZE(规格变更中)，7:VERIFY_RESIZE(检查是否可规格变更中)，8:REVERT_RESIZE(规格变更回退中)，9:PASSWORD(更新密码中)，10:REBOOT(重启中)，11:HARD_REBOOT(硬重启中)，12:DELETED(已删除)，14:ERROR(云主机发生错误)，15:STOPPED(已停止)，16:SHUTOFF(已关闭)，17:MIGRATING(迁移中)，18: UNRECOGNIZED(未知状态)。 |
|
serverTypes
|
<enum(VM,IRONIC,EBM)> array(multi)
|
是
|
云主机类型。 |
|
serverVmTypes
|
<enum(highIO,exclusive,memImprove,common,gpu,highPerformance,commonIntroductory,commonNetImprove,compute,computeNetImprove,memNetImprove,localStorage,localStorageEnhance,xlargeMemory,highFrequency,vgpu,normalComputeImprove,normalNetEnhance,storeEnhance,computeEnhance,armCompute,armNPU,economyCompute,vmexTest,edgeCommonNetImprove,edgeGPU,general,npu,pop,memoryDoubleCard,computeG2,memoryHBACard,localStorageLow,localStorageDoubleCard,superCompute,edgeBalance,edgeCompute,edgeLocalStorage,edgeCdn,edgeMem,edgeComputeVM,edgeDomesticARM,edgeDomesticX86,intelligentCompute,generalEnhance,universal,commonNetExclusive)> array(multi)
|
否
|
云主机类型下的主机类型。 |
|
productTypes
|
<enum(NORMAL,DE_CLOUD,AUTOSCALING,VO,CDN,PAAS_MASTER,PAAS_SLAVE,VCPE,EMR,LOGAUDIT,MSE,BASTION,NEXT_GENERATION_FIREWALL)> array(multi)
|
是
|
云主机属于哪个产品类型，NORMAL：普通云主机，DE_CLOUD：专属云云主机，AUTOSCALING：弹性伸缩云主机，VO：VO模板编配云主机，CDN：CDN云主机，PAAS_MASTER：PAAS容器控制节点云主机PAAS_SLAVE：PAAS容器业务节点云主机，VCPE：VCPE云主机，EMR：EMR产品云主机，LOGAUDIT：日志审计产品云主机，MSE：MSE产品云主机，BASTION：云堡垒机产品云主机。 |
|
imageOsTypes
|
<enum(linux,windows,other)> array(multi)
|
否
|
云主机操作系统类型。 |
|
rangeInServerIds
|
<string> array(multi)
|
否
|
范围内主机ID集合。 |
|
tagIds
|
<string> array(multi)
|
否
|
标签ID集合。 |
|
excludeFlavorRefs
|
<string> array(multi)
|
否
|
需要排除的FlavorRef。 |
|
host
|
string
|
否
|
云主机所属宿主物理机编号。 |
|
serverName
|
string
|
否
|
云主机名称。 |
|
serverId
|
string
|
否
|
云主机ID。 |
|
cpu
|
integer(int32)
|
否
|
cpu个数（核）。 |
|
ram
|
integer(int32)
|
否
|
内存大小（MB）。 |
|
disk
|
integer(int32)
|
否
|
系统盘大小（GB）。 |
|
opStatus
|
enum(CREATING,OK,REBOOTING,HARD_REBOOTING,FROZEN,BACKUP_REBUILDING,REBUILDING,RESIZING,SHELVING,UNSHELVING,STARTING,STOPING,HARD_STOPING,PASSWORD_UPDATING,BACKUPING,IMAGE_CREATING,UNRECOGNIZED,BOOT_VOLUME_RESIZING,DELETING,SECOND_DELETING,MIGRATING,CLONE,ORDERGET,UNSAVING,SAVING,LIVE_MIGRATING)
|
否
|
云主机op侧状态。 |
|
startDate
|
string(date-time)
|
否
|
开始时间。 |
|
endDate
|
string(date-time)
|
否
|
结束时间。 |
|
publicIp
|
string
|
否
|
公网IP地址。 |
|
privateIp
|
string
|
否
|
内网IP地址。 |
|
securityGroupId
|
string
|
否
|
安全组ID。 |
|
networkId
|
string
|
否
|
网卡所属的网络ID。 |
|
routerId
|
string
|
否
|
routerId。 |
|
vpcId
|
string
|
否
|
VPC的ID。 |
|
unBindFip
|
boolean
|
否
|
存在未绑定fip port的主机。 |
|
mountVolumeId
|
string
|
否
|
绑定的卷ID。 |
|
unMountVolumeId
|
string
|
否
|
未绑定的卷ID。 |
|
deCloudIdForIronic
|
string
|
否
|
查询Decloud下的物理机节点使用。 |
|
deCloudIdForVm
|
string
|
否
|
查询Decloud下的虚拟机节点使用。 |
|
imageId
|
string
|
否
|
云主机镜像ID。 |
|
page
|
integer(int32)
|
否
|
列表分页页数，起始页为1（当查询大量云主机时此字段必填）。 |
|
size
|
integer(int32)
|
否
|
列表分页每页大小（当查询大量云主机时此字段必填，建议此值在50以下）。 |
|
keyName
|
string
|
否
|
云主机密钥名称。 |
|
unBindBackupPolicy
|
boolean
|
否
|
云主机是否绑定备份策略。 |
|
backupPolicyId
|
string
|
否
|
云主机绑定的备份策略ID。 |
|
hasBackup
|
boolean
|
否
|
云主机是否有备份。 |
|
visible
|
boolean
|
是
|
云主机是否可见。 |
|
queryWordId
|
string
|
否
|
模糊查询云主机ID。 |
|
queryWordName
|
string
|
否
|
模糊查询云主机名称或公网IP。 |
|
backupPolicyNeeded
|
boolean
|
否
|
是否需要返回云主机备份策略的信息。 |
|
groupId
|
string
|
否
|
群组ID。 |
|
excludeGroupId
|
string
|
否
|
需排除的群组ID。 |
|
needMainPortId
|
boolean
|
否
|
是否需要裸金属主网卡ID。 |
|
recycle
|
boolean
|
否
|
是否放入回收站。 |
|
createSource
|
enum(API_DEFAULT,API_VO,API_EDGE,API_CDN,API_PAAS_MASTER,API_PAAS_SLAVE,API_VCPE,API_EMR,API_LOGAUDIT,API_MSE,API_CLOUD_GAMING,API_ROS,MOP_DEFAULT,MOP_VCPE,MOP_DISTRIBUTOR,MOP_LOGAUDIT,WEB_DEFAULT,WEB_ONE_CLICK,WEB_H5,WEB_ORDER_PAGE,UNRECOGNIZED)
|
否
|
请求来源。 |
|
imageName
|
string
|
否
|
云主机镜像名称。 |
|
specsName
|
string
|
否
|
规格。 |
|
tagNeeded
|
boolean
|
否
|
是否查询标签信息。取值范围:
默认值: false。 |
请求示例
GET https://ecloud.10086.cn/api/openapi-console-web/v3/server/without/network返回参数
返回码：200
OK
|
参数名称
|
类型
|
描述
|
|
body
|
分页查询统一返回结构体«云主机返回体»
|
请求成功时返回的数据 |
|
content
|
<云主机返回体> array
|
分页查询返回的具体结构体 |
|
actualSystemImage
|
string
|
实际系统镜像 |
|
adminPaused
|
boolean
|
主机是否封堵 |
|
adminPausedTip
|
string
|
封堵提示 |
|
authority
|
boolean
|
是否赋予可见权限 |
|
availabilityZone
|
string
|
az |
|
bootVolumeType
|
enum(local,capacity,highPerformance,performanceOptimization,highPerformanceyc,performanceOptimizationyc)
|
云主机volume类型 |
|
createdTime
|
string(date-time)
|
创建时间 |
|
credibleStatus
|
enum(CREDIBLE,INCREDIBLE,UNMEASURED,UNOPENED)
|
云主机可信状态 |
|
crossRegionMigrate
|
boolean
|
是否跨可用区迁移中。false不是跨可用区迁移中，true跨可用区迁移中 |
|
deCloudId
|
string
|
宿主机集群ID |
|
deCloudServerName
|
string
|
宿主机名称 |
|
deleted
|
integer(int32)
|
是否已删除 |
|
description
|
string
|
云主机描述 |
|
ecStatus
|
enum(active,build,rebuild,rescue,suspended,paused,resize,verify_resize,revert_resize,password,reboot,hard_reboot,deleted,unknown,error,stopped,shutoff,migrating,shelved,shelved_offloaded,shelved_saved,soft_deleted,unrecognized)
|
云主机底层状态 |
|
flavorRef
|
string
|
规格ID |
|
groupId
|
string
|
群组ID |
|
hwHost
|
string
|
所属物理机编号 |
|
hwHostId
|
string
|
所属物理机ID |
|
id
|
string
|
云主机ID |
|
imageName
|
string
|
系统镜像名称 |
|
imageOsType
|
enum(linux,windows,other)
|
镜像操作系统类型 |
|
imageRef
|
string
|
系统镜像ID |
|
ironicNodeId
|
string
|
裸金属node的ID |
|
isShow
|
boolean
|
内循环账号资源是否展示 |
|
keyName
|
string
|
密钥对名称 |
|
maxPorts
|
integer(int32)
|
网卡数量 |
|
maxVolumes
|
integer(int32)
|
最大可挂载硬盘数量 |
|
name
|
string
|
云主机名称 |
|
opStatus
|
enum(CREATING,OK,REBOOTING,HARD_REBOOTING,FROZEN,BACKUP_REBUILDING,REBUILDING,RESIZING,SHELVING,UNSHELVING,STARTING,STOPING,HARD_STOPING,PASSWORD_UPDATING,BACKUPING,IMAGE_CREATING,UNRECOGNIZED,BOOT_VOLUME_RESIZING,DELETING,SECOND_DELETING,MIGRATING,CLONE,ORDERGET,UNSAVING,SAVING,LIVE_MIGRATING)
|
云主机状态 |
|
operationFlag
|
integer(int32)
|
operationFlag |
|
productType
|
enum(NORMAL,DE_CLOUD,AUTOSCALING,VO,CDN,PAAS_MASTER,PAAS_SLAVE,VCPE,EMR,LOGAUDIT,MSE,BASTION,NEXT_GENERATION_FIREWALL)
|
云主机属于哪个产品类型 |
|
recycle
|
boolean
|
是否放入回收站，0：否，1：是 |
|
recycleCount
|
integer(int32)
|
放入回收站次数 |
|
recycleStatus
|
enum(UNRECYCLE,RECYCLE_TO_BE_DELETED,RECYCLE_RECOVER_IN_PROGRESS,RECYCLE_RECOVER_FAILED)
|
回收状态 |
|
recycleTime
|
string(date-time)
|
放入回收站时间 |
|
region
|
string
|
可用区 |
|
releaseProtect
|
boolean
|
云主机是否开启实例释放保护 |
|
replicateType
|
integer(int32)
|
容灾主机类型：0普通主机，1生产实例，2容灾实例 |
|
serverBackupPolicyResp
|
云主机列表中备份策略返回体
|
云主机备份策略返回体 |
|
policyId
|
string
|
策略ID |
|
policyName
|
string
|
策略名称 |
|
serverType
|
enum(VM,IRONIC,EBM)
|
云主机类型 |
|
serverVmType
|
enum(highIO,exclusive,memImprove,common,gpu,highPerformance,commonIntroductory,commonNetImprove,compute,computeNetImprove,memNetImprove,localStorage,localStorageEnhance,xlargeMemory,highFrequency,vgpu,fpga,normalComputeImprove,normalNetEnhance,storeEnhance,computeEnhance,armCompute,armNPU,economyCompute,vmexTest,edgeCommonNetImprove,edgeGPU,general,npu,pop,memoryDoubleCard,computeG2,memoryHBACard,localStorageLow,localStorageDoubleCard,superCompute,edgeBalance,edgeCompute,edgeLocalStorage,edgeCdn,edgeMem,edgeComputeVM,edgeDomesticARM,edgeDomesticX86,intelligentCompute,generalEnhance,universal,commonNetExclusive,UNRECOGNIZED)
|
云主机类型下的主机类型 |
|
serverVmTypeDesc
|
string
|
云主机类型下的主机类型名称 |
|
specsName
|
string
|
规格名称 |
|
status
|
integer(int32)
|
资源状态 |
|
stoppedMode
|
boolean
|
关机模式。false关机继续收费、true关机不收费 |
|
systemDiskId
|
string
|
系统盘ID |
|
tags
|
<ServerTagsResp> array
|
云主机标签返回列表 |
|
tagId
|
string
|
标签ID |
|
tagKey
|
string
|
标签键 |
|
tagValue
|
string
|
标签值 |
|
task
|
string
|
底层任务描述 |
|
userId
|
string
|
用户ID |
|
vaz
|
string
|
边缘计算虚拟可用区 |
|
vcpu
|
integer(int32)
|
cpu个数（核） |
|
vdisk
|
integer(int32)
|
系统盘大小（GB） |
|
visible
|
boolean
|
云主机是否可见 |
|
vmemory
|
integer(int32)
|
内存大小（MB） |
|
total
|
integer
|
满足查询条件的总个数 |
|
errorCode
|
string
|
统一错误码 |
|
errorMessage
|
string
|
页面国际化错误提示 |
|
errorParams
|
<string> array
|
统一错误码的自定义参数 |
|
requestId
|
string
|
每个请求的序列号 |
|
state
|
enum(OK,ERROR,EXCEPTION,ALARM,FORBIDDEN)
|
返回状态码。返回正常：OK，返回错误：ERROR，返回异常：EXCEPTION，需要告警实现的：ALARM，禁止访问：FORBIDDEN |
返回示例
返回码：200
OK
{
"requestId":"reqId-f93b7bd94011732619eaa-ca030400-1",
"state":"OK",
"body":{
"total":3,
"content":[
{
"id":"3a2bc9c8-3551-4acc-9e04-3eb750679b80",
"name":"ECS-33238048",
"vcpu":32,
"vmemory":65536,
"vdisk":80,
"hwHostId":"",
"hwHost":null,
"keyName":null,
"status":1,
"imageRef":"a31ccd1a-461a-4837-a186-98f5173bcb4b",
"imageName":"BC-Linux for Euler 22.10 64位",
"imageOsType":"linux",
"flavorRef":"ecloud-compute-8378C-12.5-003200640000",
"systemDiskId":"5d8473e9-6fc9-4792-9d10-a74be15ba44f",
"task":"",
"createdTime":"2024-06-25 10:45:29",
"deleted":0,
"availabilityZone":"ecloud_compute_c5_zone",
"serverType":"VM",
"serverVmType":"compute",
"productType":"NORMAL",
"opStatus":"OK",
"ecStatus":"active",
"credibleStatus":"UNOPENED",
"visible":true,
"authority":true,
"bootVolumeType":"highPerformance",
"adminPaused":false,
"userId":"CIDC-U-71a547de30b949b2bdc661d5a33e6235",
"region":"N0512-JS-SZFH01",
"vaz":null,
"description":null,
"groupId":"",
"operationFlag":0,
"specsName":"c5.8xlarge.2",
"maxVolumes":null,
"maxPorts":6,
"deCloudServerName":null,
"deCloudId":null,
"ironicNodeId":null,
"isShow":true,
"recycle":false,
"recycleTime":null,
"recycleCount":0,
"recycleStatus":"UNRECYCLE",
"releaseProtect":false,
"stoppedMode":false,
"crossRegionMigrate":false,
"adminPausedTip":null,
"actualSystemImage":""
},
{
"id":"5dc33e27-9edd-46e8-8e7d-f162063d44a0",
"name":"ECS-5730659111",
"vcpu":2,
"vmemory":4096,
"vdisk":40,
"hwHostId":"",
"hwHost":null,
"keyName":null,
"status":1,
"imageRef":"a31ccd1a-461a-4837-a186-98f5173bcb4b",
"imageName":"BC-Linux for Euler 22.10 64位",
"imageOsType":"linux",
"flavorRef":"ecloud-compute-8378C-0.8-000200040000",
"systemDiskId":"432e5c0f-62e9-49fa-ad20-35fcbc4cc1b5",
"task":"",
"createdTime":"2024-06-12 13:43:40",
"deleted":0,
"availabilityZone":"ecloud_compute_c5_zone",
"serverType":"VM",
"serverVmType":"compute",
"productType":"NORMAL",
"opStatus":"OK",
"ecStatus":"active",
"credibleStatus":"UNOPENED",
"visible":true,
"authority":true,
"bootVolumeType":"highPerformance",
"adminPaused":false,
"userId":"CIDC-U-71a547de30b949b2bdc661d5a33e6235",
"region":"N0512-JS-SZFH01",
"vaz":null,
"description":"",
"groupId":"a360aba4-4370-490a-b91c-a72a70c0cb65",
"operationFlag":0,
"specsName":"c5.large.2",
"maxVolumes":null,
"maxPorts":2,
"deCloudServerName":null,
"deCloudId":null,
"ironicNodeId":null,
"isShow":true,
"recycle":false,
"recycleTime":null,
"recycleCount":0,
"recycleStatus":"UNRECYCLE",
"releaseProtect":false,
"stoppedMode":false,
"crossRegionMigrate":false,
"adminPausedTip":null,
"actualSystemImage":""
},
{
"id":"8eb97c84-982a-4c87-98e1-cff42a3dec36",
"name":"ECS-21905361112211",
"vcpu":1,
"vmemory":2048,
"vdisk":40,
"hwHostId":"",
"hwHost":null,
"keyName":null,
"status":16,
"imageRef":"a31ccd1a-461a-4837-a186-98f5173bcb4b",
"imageName":"BC-Linux for Euler 22.10 64位",
"imageOsType":"linux",
"flavorRef":"ecloud-normalEntry-5118-0.2-000100020020",
"systemDiskId":"a56749e5-ef8c-4c7d-94c0-bc11f7f7d56f",
"task":"",
"createdTime":"2024-05-31 15:41:31",
"deleted":0,
"availabilityZone":"ecloud_normal_entry_level_zone",
"serverType":"VM",
"serverVmType":"commonIntroductory",
"productType":"NORMAL",
"opStatus":"OK",
"ecStatus":"shutoff",
"credibleStatus":"UNOPENED",
"visible":true,
"authority":true,
"bootVolumeType":"performanceOptimization",
"adminPaused":false,
"userId":"CIDC-U-71a547de30b949b2bdc661d5a33e6235",
"region":"SZJD",
"vaz":null,
"description":"",
"groupId":"d25aae60-5f8d-4f10-84eb-5248dc8c4e69",
"operationFlag":0,
"specsName":"t2.medium.2",
"maxVolumes":null,
"maxPorts":null,
"deCloudServerName":null,
"deCloudId":null,
"ironicNodeId":null,
"isShow":true,
"recycle":false,
"recycleTime":null,
"recycleCount":0,
"recycleStatus":"UNRECYCLE",
"releaseProtect":false,
"stoppedMode":false,
"crossRegionMigrate":false,
"adminPausedTip":null,
"actualSystemImage":""
}
]
}
}