接口功能介绍
通过参数批量查询物理机信息
接口约束
无
URI
GET /v4/ebm/list
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 区域ID | 73f321ea-62ff-11ec-a8bc-005056898fe0 | |
azName | 是 | String | 可用区名称或者 default。您可以调用 https://www.ctyun.cn/document/10026730/10040590 获取资源池信息,查询结果中zoneList内返回可用区名称,若查询结果中zoneList为空,即为单可用区,本字段填写default | az2 | |
resourceID | 否 | String | resourceId,资源ID | f13e86bd53b4426594796987faaea01c | |
ip | 否 | String | 浮动IP | 192.168.0.1 | |
name | 否 | String | 实例名称 | pm-10901 | |
vpcID | 否 | String | VPC的UUID | a64ddb73-3021-5a8d-9abd-b0a12e429690 | |
subnetID | 否 | String | 子网UUID | c45512bf-7919-55a9-a106-5f4aa9194c7c | |
deviceType | 否 | String | 套餐类型 | physical.t3.large | |
deviceUUIDList | 否 | String | 设备uuid 用,分隔 | d-gutvjbzdfquu9ufiaheuerrpjhxz,d-gutvjbzdfquu9ufiaheuerrpjhxa | |
queryContent | 否 | String | 对名称,内网IP,displayName这些字段模糊查询 | ||
instanceUUIDList | 否 | String | instance_uuids,实例UUID 用,分隔 | ss-rtkjng87ovlyda013spdb0shvfaj,ss-rtkjng87ovlyda013spdb0shvfat | |
id | 否 | String | id | ||
ipType | 否 | String | IP类型 4/6 | ||
status | 否 | String | 实例状态,取值范围可参考 status参数取值列表 | RUNNING | |
sort | 否 | String | 排序类型。取值范围:[expire_time]。expire_time表示按到期时间排序,默认为降序排序 | expire_time | |
asc | 否 | Boolean | 排序参数。true表示升序,false表示降序。当未指定排序类型 sort 时,此参数无效 | true | |
vipID | 否 | String | vip_id | ||
volumeUUID | 否 | String | 卷UUID | ||
pageNo | 否 | Integer | 页码,默认值:1 | 1 | |
pageSize | 否 | Integer | 每页记录数目,取值范围:[1~10000],默认值:10,单页最大记录不超过10000 | 10 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败),默认值:800 | 800 | |
errorCode | String | 业务细分码,为product.module.code三段式码,详见错误码说明 | Ebm.Instance.NotValid | |
message | String | 响应结果的描述,一般为英文描述 | error request | |
description | String | 响应结果的描述,一般为中文描述 | 错误请求 | |
returnObj | Object | 返回参数,参考表returnObj | {} | returnObj |
表returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
currentCount | Integer | 当前页数量 | 2 | |
totalCount | Integer | 总记录数 | 10 | |
totalPage | Integer | 总页数 | 5 | |
results | Array of Object | 分页明细,元素类型是result,定义请参考表result | [{}{}] | results |
表results
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
regionID | String | 资源池ID | 73f321ea-62ff-11ec-a8bc-005056898fe0 | |
region | String | 资源池名 | cn-huhehaote-t11 | |
azName | String | 可用区名 | az1 | |
resourceID | String | 资源ID | f13e86bd53b4426594796987faaea01c | |
instanceUUID | String | 物理机ID | ss-rtkjng87ovlyda013spdb0shvfaj | |
deviceUUID | String | 设备ID | d-gutvjbzdfquu9ufiaheuerrpjhxz | |
deviceType | String | 设备类型 | physical.t3.large | |
displayName | String | 物理机展示名 | pm-1090 | |
name | String | 物理机名称 | pm-10901 | |
description | String | 物理机描述 | ||
zabbixName | String | zabbixName | ss-rtkjng87ovlyda013spdb0shvfaj | |
systemVolumeRaidID | String | 本地系统盘raid id | r-wtzluqacgzzxgunnabdkpnpjew3d | |
dataVolumeRaidID | String | 数据盘raid id | r-qytwf9r5h0yn9x4evjkyr0n1cwyb | |
imageID | String | 镜像ID | im-as6g7uju3cesx8n7qru8vqn2iqkf | |
osType | Integer | 操作系统类型编号 | 4 | |
osTypeName | String | 操作系统类型 | Ubuntu | |
vpcID | String | 主网卡网络ID | a64ddb73-3021-5a8d-9abd-b0a12e429690 | |
vpcName | String | 私有云名称 | vpc-f60a | |
subnetID | String | 主网卡子网id | c45512bf-7919-55a9-a106-5f4aa9194c7c | |
publicIP | String | 公网IPIPv4地址 | null | |
privateIP | String | 主网卡私有IPv4地址 | 192.168.0.18 | |
publicIPv6 | String | 公网IPv6地址 | null | |
privateIPv6 | String | 私有IPv6地址 | 100:1:172:9400:6f5b:2bdb:47c6:5f8f | |
ebmState | String | 物理机状态 | RUNNING | |
flavor | Object | 规格信息 | flavor | |
interfaces | Array of Object | 网卡信息 | interfaces | |
networkInfo | Object | 网络信息 | networkInfo | |
raidDetail | Object | 磁盘阵列信息 | raidDetail | |
attachedVolumes | Array of String | 挂载的硬盘ID | bb97a0c4-a5fa-4ee1-928c-d9c4fd14bf73 | |
deviceDetail | Object | 设备信息 | deviceDetail | |
freezing | Boolean | 是否冻结 | false | |
expired | Boolean | 是否到期 | false | |
createTime | String | 创建时间 | 2022-09-09T03:42:12Z | |
updatedTime | String | 最后更新时间 | 2022-09-09T08:28:08Z | |
expiredTime | String | 到期时间 | 2023-03-09T03:42:12Z | |
releaseDate | String | 预期释放时间 | ||
onDemand | Boolean | 付费方式,true表示按量付费; false为包周期 | false |
表flavor
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
numaNodeAmount | Integer | cpu numa | 2 | |
nicAmount | Integer | 网卡 | 9 | |
memSize | Integer | 内存大小 | 32 | |
ram | Integer | 内存数量 | 24 | |
vcpus | Integer | vCPU数量 | 24 | |
cpuThreadAmount | Integer | cpu进程数目 | 2 | |
deviceType | String | 设备类型 | physical.t3.large |
表interfaces
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
interfaceUUID | String | 网卡UUID | ifg-fbf42wodxlqu8jjzsfkhipopxcul | |
master | Boolean | 是否为主网卡 | true | |
vpcUUID | String | 网络UUID | a64ddb73-3021-5a8d-9abd-b0a12e429690 | |
subnetUUID | String | 子网UUID | c45512bf-7919-55a9-a106-5f4aa9194c7c | |
portUUID | String | Port UUID | port-r8h4uowjne | |
ipv4 | String | IPv4地址 | 192.168.0.18 | |
ipv4Gateway | String | IPv4网关 | 192.168.0.1 | |
ipv6 | String | IPv6地址 | 100:1:172:9400:78de:79a2:f177:2d60 | |
ipv6Gateway | String | IPv4网关 | fe80::f816:3eff:fe6c:2ef0 | |
vipUUIDList | Array of String | vip UUID列表 | df5e7b78-00a0-525f-ab15-bb5e083ffe6d | |
vipList | Array of String | vip列表 | 192.168.0.10 | |
securityGroups | Array of String | 安全组信息列表 | securityGroups |
表securityGroups
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
securityGroupID | String | 安全组UUID | 71386230-c9e7-5465-85fc-29e26f79806d | |
securityGroupName | String | 安全组名称 | Default-Security-Group |
表networkInfo
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
subnetUUID | String | 子网ID | c45512bf-7919-55a9-a106-5f4aa9194c7c | |
vpcName | String | 私有云名称 | vpc-f60a | |
vpcID | String | 私有云ID | a64ddb73-3021-5a8d-9abd-b0a12e429690 |
表raidDetail
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
systemVolume | Object | 系统盘 | {} | systemVolume |
dataVolume | Object | 数据盘 | {} | dataVolume |
表systemVolume
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
uuid | String | UUID | r-wtzluqacgzzxgunnabdkpnpjew3d | |
volumeType | String | 卷类型 | SYSTEM | |
name | String | raid名称 | RAID1 | |
volumeDetail | String | 卷详情 | 2*480 SSD |
表dataVolume
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
uuid | String | UUID | r-qytwf9r5h0yn9x4evjkyr0n1cwyb | |
volumeType | String | 卷类型 | physical.t3.large | |
name | String | 英文名称 | NORAID | |
volumeDetail | String | 卷详情 | 0 |
表deviceDetail
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
cpuSockets | Integer | 物理cpu数量 | 2 | |
numaNodeAmount | Integer | 单个cpu numa node数量 | 2 | |
cpuAmount | Integer | 单个cpu核数 | 24 | |
cpuThreadAmount | Integer | 单个cpu核超线程数量 | 2 | |
cpuManufacturer | String | cpu厂商;Intel ,AMD,Hygon,HiSilicon, loongson等 | "Intel" | |
cpuModel | String | cpu型号 | 6248R | |
cpuFrequency | String | cpu频率(G) | 3.0 | |
memAmount | Integer | 内存数 | 24 | |
memSize | Integer | 内存大小(G) | 32 | |
memFrequency | Integer | 内存频率(MHz) | 2666 | |
nicAmount | Integer | 网卡数 | 9 | |
nicRate | Integer | 网卡传播速率(GE) | 25 | |
systemVolumeAmount | Integer | 系统盘数量 | 2 | |
systemVolumeSize | Integer | 系统盘单盘大小(GB) | 480 | |
systemVolumeType | String | 系统盘介质类型; 包含SSD、HDD | "SSD" | |
systemVolumeInterface | String | 系统盘接口类型;包含SAS、SATA、NVMe | "SATA" | |
systemVolumeDescription | String | 系统盘描述 | 2*480 SSD | |
dataVolumeAmount | Integer | 数据盘数量 | 0 | |
dataVolumeSize | Integer | 数据盘单盘大小(GB) | 0 | |
dataVolumeInterface | String | 数据盘接口;包含SAS、SATA、NVMe | "SATA" | |
dataVolumeType | String | 数据盘介质参数类型; 包含SSD、HDD | "SSD" | |
dataVolumeDescription | String | 数据盘描述 | ||
smartNicExist | Boolean | 是否有智能网卡,true为弹性裸金属; false为标准裸金属 | true | |
nvmeVolumeAmount | Integer | NVME硬盘数量 | 0 | |
nvmeVolumeSize | Integer | NVME硬盘单盘大小(GB) | 0 | |
nvmeVolumeType | String | NVME介质类型; 包含SSD、HDD | ||
nvmeVolumeInterface | String | NVME接口类型;包含SAS、SATA、NVMe | ||
gpuAmount | Integer | GPU数目 | 1 | |
gpuSize | Integer | GPU显存 | 40 | |
gpuManufacturer | String | GPU厂商;Nvidia,Huawei,Cambricon等 | Nvidia | |
gpuModel | String | GPU型号 | A100 | |
supportCloud | Boolean | 是否支持云盘 | true | |
cloudBoot | Boolean | 是否支持云盘启动 | true |
status参数取值列表
序号 | status | 说明 |
---|---|---|
1 | CREATING | 创建中 |
2 | STARTING | 启动中 |
3 | RUNNING | 运行中 |
4 | STOPPING | 关机中 |
5 | STOPPED | 已关机 |
6 | RESTARTING | 重启中 |
7 | ERROR | 故障中 |
8 | REINSTALLING | 重装系统中 |
9 | MAINTAINING | 维护中 |
10 | RESETTING_PASSWORD | 重置密码中 |
11 | DELETE | 删除 |
12 | ADDACH_VOLUME_IN_RUNNING | 运行状态挂载卷中 |
13 | DETACH_VOLUME_IN_RUNNING | 运行状态卸载卷中 |
14 | ADDACH_VOLUME_IN_STOPPED | 关机状态挂载卷中 |
15 | DETACH_VOLUME_IN_STOPPED | 关机状态卸载卷中 |
16 | ADDING_NETWORK | 添加网卡中 |
17 | DELETING_NETWORK | 删除网卡中 |
18 | TRANSFERING | 迁移中 |
19 | EXPORT_IMAGE | 导出镜像中 |
20 | MODIFY_NETWORK | 重置网络中 |
21 | RESETTING_HOSTNAME | 重置hostname中 |
22 | UNSUBSCRIBING | 包年包月物理机退订中/按量付费物理机删除中 |
23 | UNSUBSCRIBED | 包年包月物理机已退订 |
- RUNNING 运行中 可进行关机、重启操作、挂载卷、卸载卷、添加网卡、删除网卡
- STOPPED 已关机 可进行开机、重装、重置密码、删除、挂载卷、卸载卷、添加网卡、删除网卡、重置内网IP
- ERROR 故障 可进行删除操作
请求示例
请求头header
无
请求体body
{
"regionID":"xxxxxxxx",
"ip":"192.168.0.1",
"pageNo":1,
"pageSize":10
}
响应示例
{
"statusCode": 800,,
"errorCode": "",
"message": "SUCCESS",
"description": "成功"
"returnObj": {
"totalCount": 10,
"currentCount": 2,
"totalPage": 5,
"results": [{
"regionID": "73f321ea-62ff-11ec-a8bc-005056898fe0",
"region": "cn-huhehaote-t11",
"azName": "az1",
"resourceID": "f13e86bd53b4426594796987faaea01c",
"instanceUUID": "ss-rtkjng87ovlyda013spdb0shvfaj",
"deviceUUID": "d-gutvjbzdfquu9ufiaheuerrpjhxz",
"deviceType": "physical.t3.large",
"displayName": "pm-1090",
"name": "pm-10901",
"description": "",
"zabbixName": "ss-rtkjng87ovlyda013spdb0shvfaj",
"systemVolumeRaidID": "r-wtzluqacgzzxgunnabdkpnpjew3d",
"dataVolumeRaidID": "r-qytwf9r5h0yn9x4evjkyr0n1cwyb",
"imageID": "im-as6g7uju3cesx8n7qru8vqn2iqkf",
"osType": 4,
"osTypeName": "Ubuntu",
"vpcID": "a64ddb73-3021-5a8d-9abd-b0a12e429690",
"vpcName": "vpc-f60a",
"subnetID": "c45512bf-7919-55a9-a106-5f4aa9194c7c",
"publicIP": null,
"publicIPv6": null,
"privateIP": "192.168.0.18",
"privateIPv6": "100:1:172:9400:6f5b:2bdb:47c6:5f8f",
"ebmState": "RUNNING",
"flavor": {
"vcpus": 24,
"ram": 24,
"numaNodeAmount": 2,
"memSize": 32,
"cpuThreadAmount": 2,
"id": "d-gutvjbzdfquu9ufiaheuerrpjhxz",
"deviceType": "physical.t3.large",
"nicAmount": 9
},
"interfaces": [{
"ipv4Gateway": "192.168.0.1",
"portUUID": "port-r8h4uowjne",
"vpcUUID": "a64ddb73-3021-5a8d-9abd-b0a12e429690",
"ipv4SubnetUUID": "c45512bf-7919-55a9-a106-5f4aa9194c7c",
"master": true,
"ipv4": "192.168.0.18",
"ipv6Gateway": "fe80::f816:3eff:fe6c:2ef0",
"interfaceUUID": "ifg-fbf42wodxlqu8jjzsfkhipopxcul",
"securityGroups": [{
"securityGroupID": "71386230-c9e7-5465-85fc-29e26f79806d",
"securityGroupName": "Default-Security-Group"
}],
"ipv6": "100:1:172:9400:78de:79a2:f177:2d60",
"subnetUUID": "c45512bf-7919-55a9-a106-5f4aa9194c7c",
"vipUUIDList": [],
"vipList": []
}, {
"ipv4Gateway": "192.168.0.1",
"portUUID": "port-xl0ecxi5x0",
"vpcUUID": "a64ddb73-3021-5a8d-9abd-b0a12e429690",
"ipv4SubnetUUID": "c45512bf-7919-55a9-a106-5f4aa9194c7c",
"master": false,
"ipv4": "192.168.0.19",
"ipv6Gateway": "fe80::f816:3eff:fe6c:2ef0",
"interfaceUUID": "ifg-8sne0jocn9shccahkwuyisfsnv9d",
"securityGroups": [{
"securityGroupID": "71386230-c9e7-5465-85fc-29e26f79806d",
"securityGroupName": "Default-Security-Group"
}],
"ipv6": "100:1:172:9400:6f5b:2bdb:47c6:5f8f",
"subnetUUID": "c45512bf-7919-55a9-a106-5f4aa9194c7c",
"vipUUIDList": ["df5e7b78-00a0-525f-ab15-bb5e083ffe6d"],
"vipList": ["192.168.0.10"]
}],
"networkInfo": [{
"subnetUUID": "c45512bf-7919-55a9-a106-5f4aa9194c7c",
"vpcName": "vpc-f60a",
"vpcID": "a64ddb73-3021-5a8d-9abd-b0a12e429690"
}],
"raidDetail": {
"systemVolume": {
"uuid": "r-wtzluqacgzzxgunnabdkpnpjew3d",
"volumeType": "SYSTEM",
"name": "RAID1",
"volumeDetail": "2*480 SSD"
},
"dataVolume": {
"uuid": "r-qytwf9r5h0yn9x4evjkyr0n1cwyb",
"volumeType": "physical.t3.large",
"name": "NORAID",
"volumeDetail": "0"
}
},
"attachedVolumes": ["bb97a0c4-a5fa-4ee1-928c-d9c4fd14bf73", "3a0835d0-7600-47d9-8011-e1df199a874c"],
"deviceDetail": {
"systemVolumeDescription": "2*480 SSD",
"cpuAmount": 24,
"nameZh": "Inspur",
"memFrequency": 2666,
"dataVolumeSize": 0,
"supportCloud": true,
"deviceType": "physical.t3.large",
"dataVolumeDescription": "",
"nameEn": "Inspur",
"cpuSockets": 2,
"cloudBoot": true,
"nicAmount": 9,
"dataVolumeType": "",
"memSize": 32,
"numaNodeAmount": 2,
"cpuFrequency": "3.0",
"memAmount": 24,
"systemVolumeInterface": "SATA",
"dataVolumeInterface": "",
"nicRate": 25,
"cpuModel": "6248R",
"smartNicExist": true,
"nvmeVolumeInterface":"SATA",
"gpuAmount": 0,
"gpuManufacturer": "",
"gpuSize": 0,
"gpuModel": "",
"systemVolumeType": "SSD",
"systemVolumeSize": 480,
"systemVolumeAmount": 2,
"dataVolumeAmount": 0,
"nvmeVolumeAmount": 0,
"cpuThreadAmount": 2,
"nvmeVolumeSize": 0,
"nvmeVolumeType":"SSD",
"cpuManufacturer": "Intel"
},
"freezing": false,
"expired": false,
"releaseDate": "",
"createTime": "2022-09-09T03:42:12Z",
"updatedTime": "2022-09-09T08:28:08Z",
"expiredTime": "2023-03-09T03:42:12Z",
"onDemand": false,
}]
}
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功 |
错误码
错误码 | 描述 |
---|---|
Ebm.Instance.NotValid | 请求参数非法 |
Ebm.Instance.NotFound | 物理机不存在 |
Ebm.Common.CheckError | 内部错误,请重试 |
其他 | 参见公共错误码说明 |