1)接口功能介绍
虚机列表查询。
2)接口约束
nodeCode边缘池id需要正确,可通过查看区域集群编码列表接口获取。
3)URI
GET /v1/listInstance。
4)请求参数
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
nodeCode | 是 | String | 边缘池id,可通过查看区域集群编码列表接口获取。 | cn-guangzhou3 | |
state | 否 | String | 虚机运行状态,状态如下,OUnSet-未定义,暂只用作查询所有状态的条件,OStarting-启动中,ORunning-运行中,OStopping-正在关机,OStopped-已关机,ODeleting-删除中,ODeleted-已删除,OFailed-启动异常,ORebooting-重启中,OCreating-创建中,默认空,不生效 | ORunning | |
instanceId | 否 | String | 虚机id,示例值:evm-xxxxxxxxxxx,默认空,不填则查询所有虚机id | evm-xxxxxxxxxxx | |
customName | 否 | String | 自定义实例名,默认空,不填则查询所有自定义实例名 | 管理服务 | |
publicIp | 否 | String | 弹性公网ip,默认空,不填则查询所有弹性公网ip | 58.12.34.12 | |
internalIp | 否 | String | 内网ip,默认空,不填则查询所有内网ip | 192.34.0.1 | |
securityGroupID | 否 | Integer | 安全组ID,默认空,不填则查询所有安全组ID | 12 | |
gpuState | 否 | String | GPU状态,可填值为OGpuState_All-全部状态,OGpuState_Available-挂载并正常使用中,OGpuState_Unavailable-GPU不可用, (没有GPU, 或者挂载过但已卸载),默认空,不生效 | OGpuState_All | |
page | 否 | Integer | 当前页数,默认值为1 | 1 | |
perPageNum | 否 | Integer | 每页显示的记录条数,默认值为10 | 10 |
5)响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
requestId | 是 | String | 请求id | b84233d3-0796-xxx | |
status | 是 | Object | 应答状态 | status | |
data | 是 | Object | 返回数据 | data |
表 status
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
message | 是 | String | 状态描述 | Success | |
code | 是 | String | 状态码 | Success |
表 data
参数名称 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
page | 是 | Integer | 当前页 | 3 | |
perPageNum | 是 | Integer | 页大小 | 0 | |
totalPage | 是 | Integer | 总页数 | 0 | |
total | 是 | Integer | 总条目数 | 0 | |
vmInfoList | 是 | List | 虚机列表 | vmInfoList |
表 vmInfoList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
baseInfo | 否 | Object | 基础信息 | baseInfo | |
gpuInfo | 否 | Object | gpu信息 | gpuInfo | |
id | 否 | String | 虚机ID | evm-*** | |
internalIps | 否 | List | 内网ip列表 | ||
publicIps | 否 | List | 公网ip列表 | ||
securityGroupIDs | 否 | List | 安全组列表 | [2] | |
status | 否 | String | 虚机状态,UnSet-未定义,暂只用作查询所有状态的条件, Starting-启动中, Running-运行中, Stopping-正在关机, Stopped-已关机, Deleting-删除中, Deleted-已删除, Failed-启动异常, Rebooting-重启中, Creating-创建中 | ||
vmLabelInfo | 否 | String | 内网Ip列表 | ||
vpc | 否 | Object | 已废弃 |
表 baseInfo
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
chargeType | 否 | String | 商务类型,Tryout-试用,InBusinessPay-商用付费,InBusinessNotPay-商用不付费 | InBusineesPay | |
imageInfo | 否 | Object | 镜像信息 | imageInfo | |
instanceInfo | 否 | Object | 虚机信息 | instanceInfo |
表 imageInfo
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
imageId | 否 | Integer | 镜像id | 10 | |
imageName | 否 | String | 镜像系统平台 | CentOS-7.7 | |
imagePlatform | 否 | String | 镜像类型 | CENTOS | |
imageType | 否 | String | 镜像类型, PUBLIC-公有, PRIVATE-私有, SHARE-共享 | PUBLIC |
表 instanceInfo
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
bandwidthUpperLimit | 否 | Integer | 带宽上限,单位bps | 1000 | |
cpuExclusive | 否 | Boolean | 是否独占CPU | false | |
hugePageSizeType | 否 | String | 大页内存类型,HugePageSizeNoSupport-默认不支持,HugePageSize2MBi-2M,HugePageSize1GBi-1G | HugePageSizeNoSupport | |
instanceSpec | 否 | String | 虚机规格大类名 | 宿主共享型 | |
instanceSpecName | 否 | String | 实例规格名称 | c3.la2.s2-test | |
memory | 否 | Integer | 内存大小,单位G | 4 | |
name.customName | 否 | String | 自定义名称 | 管理虚机 | |
name.systemName | 否 | String | 虚机唯一id | evm-xxxx | |
paasBusinessType | 否 | String | paas虚机类型 | 1 | |
regionCluster | 否 | String | 地域 | 江苏 | |
specializedType | 否 | Integer | 已废弃 | ||
vCPU | 否 | Integer | vcpu数量 | 2 |
表 gpuInfo
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
count | 否 | Integer | 数量 | 1 | |
mem | 否 | Integer | 内存大小,单位为G | 12 | |
model | 否 | String | 显卡型号 | 3060 |
6)请求示例
GET https://{host}/v1/listInstance?securityGroupID=0&instanceId=&gpuState=OGpuState_All&customName=&nodeCode=yn-lincang-1&state=ORunning&publicIp=&internalIp=&page=1&perPageNum=1
7)响应示例
{
"status": {
"message": "Success",
"code": "Success"
},
"data": {
"vmInfoList": [
{
"status": "Running",
"vmLabelInfo": [],
"gpuInfo": null,
"securityGroupIDs": [
2
],
"internalIps": [
"10.0.0.11"
],
"publicIps": [],
"vpc": null,
"baseInfo": {
"instanceInfo": {
"specializedType": 0,
"paasBusinessType": 0,
"name": {
"customName": "evm-ohn0",
"systemName": "evm-ce229jv19r78iu3nql30"
},
"bandwidthUpperLimit": 0,
"instanceSpec": "宿主共享型",
"regionCluster": "",
"vCPU": 1,
"cpuExclusive": false,
"memory": 2048,
"hugePageSizeType": "HugePageSizeNoSupport",
"instanceSpecName": "c3.la2.s2-test"
},
"chargeType": "InBusinessNotPay",
"imageInfo": {
"imagePlatform": "Linux",
"imageName": "CentOS7.6",
"imageType": "公共镜像",
"imageId": 1
}
},
"id": "evm-ce229jv19r78iu3nql30"
}
],
"totalPage": 1,
"total": 1,
"page": 1,
"perPageNum": 1
},
"requestId": "a96b7e1a-ff83-4210-abbf-005736f536b3"
}
8)状态码
状态码 | 描述 |
---|---|
Success | 表示请求成功。 |