接口说明
本接口用于查看宿主机集群内指定专属宿主机上的云主机列表信息。
URL
GET https://ecloud.10086.cn/api/openapi-ddh/customer/v3/dedicatedHost/cloudApi/v2/hosts/{dedicatedHostId}/servers
请求参数
Path
|
参数名称
|
类型
|
必填
|
描述
|
|
dedicatedHostId
|
string
|
是
|
专属宿主机ID |
Query
|
参数名称
|
类型
|
必填
|
描述
|
|
region
|
string
|
是
|
可用区，可通过查询属地的可用区信息获取。 |
|
page
|
integer(int32)
|
否
|
列表分页页数 |
|
size
|
integer(int32)
|
否
|
列表分页每页大小 |
请求示例
GET https://ecloud.10086.cn/api/openapi-ddh/customer/v3/dedicatedHost/cloudApi/v2/hosts/{dedicatedHostId}/servers返回参数
|
参数名称
|
类型
|
描述
|
|
body
|
PageListResp«专属宿主机云主机列表返回体»
|
请求成功时返回的数据 |
|
content
|
<专属宿主机云主机列表返回体> array
|
分页查询返回的具体结构体 |
|
createdTime
|
string(date-time)
|
云主机创建时间 |
|
dedicatedHostId
|
string
|
云主机所属专属宿主机ID |
|
flavorId
|
string
|
云主机规格ID |
|
imageId
|
string
|
云主机系统镜像ID |
|
imageName
|
string
|
云主机系统镜像名称 |
|
ports
|
<云主机网络详情体> array
|
云主机绑定的网络信息 |
|
fipAddress
|
string
|
公网IPV4地址 |
|
fipBandwidthSize
|
integer(int32)
|
带宽大小 |
|
fipV6Address
|
string
|
公网IPV6地址 |
|
fixedIpDetailResps
|
<FixedIp返回体> array
|
fixedIpResps |
|
bandwidthSize
|
integer(int32)
|
公网IP 带宽Mb |
|
bandwidthType
|
enum(shared,exclusive,ipv6Qos,ipv6Shared)
|
带宽类型 |
|
ipAddress
|
string
|
内网IP |
|
ipVersion
|
enum(4,6)
|
ipVsersion，v4或v6 |
|
ipv6BandwidthSize
|
integer(int32)
|
IPV6带宽值Mb |
|
publicIP
|
string
|
公网IP |
|
subnetId
|
string
|
子网ID |
|
subnetName
|
string
|
子网名称 |
|
portId
|
string
|
网卡ID |
|
portName
|
string
|
网卡名称 |
|
privateIp
|
string
|
内网IPV4地址 |
|
routerId
|
string
|
routerId |
|
subnetName
|
string
|
子网名称 |
|
vpcName
|
string
|
VPC名称 |
|
serverId
|
string
|
云主机ID |
|
serverName
|
string
|
云主机名称 |
|
serverType
|
enum(highIO,exclusive,memImprove,common,gpu,highPerformance,commonIntroductory,commonNetImprove,compute,computeNetImprove,memNetImprove,localStorage,xlargeMemory,highFrequency,vgpu,fpga,normalComputeImprove,normalNetEnhance,storeEnhance,computeEnhance,edgeCommonNetImprove,edgeGPU,general,npu,pop,memoryDoubleCard,computeG2,memoryHBACard,localStorageLow,localStorageDoubleCard,superCompute,edgeBalance,edgeCompute,edgeLocalStorage,edgeCdn,edgeMem,edgeComputeVM,edgeDomesticARM,edgeDomesticX86,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 |
|
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":[
{
"serverId":"string",
"serverName":"string",
"vcpu":2,
"vdisk":20,
"vmemory":4,
"dedicatedHostId":"string",
"status":1,
"imageId":"string",
"imageName":"string",
"flavorId":"string",
"systemDiskId":"string",
"createdTime":"string",
"serverType":"string",
"ports":[
{
"fipAddress":"string",
"fipBandwidthSize":1,
"fipV6Address":"string",
"fixedIpDetailResps":[
{
"bandwidthSize":1,
"bandwidthType":"string",
"ipAddress":"string",
"ipVersion":"string",
"ipv6BandwidthSize":1,
"publicIP":"string",
"subnetId":"string",
"subnetName":"string"
}
],
"portId":"string",
"portName":"string",
"privateIp":"string",
"routerId":"string",
"subnetName":"string",
"vpcName":"string"
}
]
}
],
"total":1
},
"errorCode":"string",
"errorMessage":"string",
"errorParams":[
"string"
],
"requestId":"string",
"state":"string"
}