接口说明
本接口用于查看宿主机集群内的云主机列表信息，接口响应中无云主机网络信息。
URL
POST https://ecloud.10086.cn/api/openapi-ddh/customer/v3/dedicatedHost/cloudApi/v2/cluster/servers
请求参数
Body
|
参数名称
|
类型
|
必填
|
描述
|
|
ServerListReq
|
专属宿主机集群上云主机列表查询请求体
|
是
|
ServerListReq |
|
dedicatedHostClusterId
|
string
|
是
|
专属宿主机集群ID |
|
page
|
integer(int32)
|
否
|
列表分页页数 |
|
queryWordName
|
string
|
否
|
云主机名称 |
|
region
|
string
|
是
|
可用区，可通过查询属地的可用区信息获取。 |
|
serverIds
|
<string> array
|
否
|
主机ID范围列表，最大可过滤50个 |
|
size
|
integer(int32)
|
否
|
列表分页每页大小，最大可设置为100 |
请求示例
POST https://ecloud.10086.cn/api/openapi-ddh/customer/v3/dedicatedHost/cloudApi/v2/cluster/servers{
"dedicatedHostClusterId":"",
"page":"",
"queryWordName":"",
"region":"",
"serverIds":[
""
],
"size":""
}返回参数
|
参数名称
|
类型
|
描述
|
|
body
|
分页查询统一返回结构体«专属宿主机上云主机列表返回体(无网络信息)»
|
请求成功时返回的数据 |
|
content
|
<专属宿主机上云主机列表返回体(无网络信息)> array
|
分页查询返回的具体结构体 |
|
createdTime
|
string(date-time)
|
云主机创建时间 |
|
dedicatedHostId
|
string
|
云主机所属专属宿主机ID |
|
flavorId
|
string
|
云主机规格ID |
|
imageId
|
string
|
云主机系统镜像ID |
|
imageName
|
string
|
云主机系统镜像名称 |
|
serverId
|
string
|
云主机ID |
|
serverName
|
string
|
云主机名称 |
|
serverType
|
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)
|
云主机类型 |
|
status
|
integer(int32)
|
云主机状态，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（已删除），13：UNKNOWN（未知），14：ERROR（云主机发生错误），15：STOPPED（已停止），16：SHUTOFF（已关闭），17：MIGRATING（迁移中），18：UNRECOGNIZED（未知状态），19：BACKUPING（备份中），20：RESTORING（备份恢复中），23：SHELVED_OFFLOADED（关机释放资源），24：SHELVED_SAVED（休眠） |
|
systemDiskId
|
string
|
云主机系统盘ID |
|
systemDiskType
|
enum(local,capacity,highPerformance,performanceOptimization,highPerformanceyc,performanceOptimizationyc)
|
系统盘类型，highPerformance：高性能型系统盘 performanceOptimization：性能优化型系统盘 highPerformanceyc: 高性能-云创 performanceOptimizationyc：性能优化型-云创 |
|
vcpu
|
integer(int32)
|
云主机vCPU核数 |
|
vdisk
|
integer(int32)
|
云主机系统盘容量 |
|
vmemory
|
integer(int32)
|
云主机内存容量 |
|
total
|
integer
|
满足查询条件的总个数 |
|
errorCode
|
string
|
统一错误码 |
|
errorMessage
|
string
|
页面国际化错误提示 |
|
errorParams
|
<string> array
|
统一错误码的自定义参数 |
|
requestId
|
string
|
每个请求的序列号 |
|
state
|
enum(OK,ERROR,EXCEPTION,ALARM,FORBIDDEN)
|
返回状态码，返回正常：OK，返回错误：ERROR，返回异常：EXCEPTION，需要告警实现的：ALARM，禁止访问：FORBIDDEN |
返回示例
{
"body":{
"content":[
{
"createdTime":"",
"dedicatedHostId":"",
"flavorId":"",
"imageId":"",
"imageName":"",
"serverId":"",
"serverName":"",
"serverType":"",
"status":"",
"systemDiskId":"",
"systemDiskType":"",
"vcpu":"",
"vdisk":"",
"vmemory":""
}
],
"total":""
},
"errorCode":"",
"errorMessage":"",
"errorParams":[
""
],
"requestId":"",
"state":""
}