接口功能介绍
该接口提供用户多台轻量型云主机信息查询功能，用户可以根据此接口的返回值得到多轻量型台云主机信息。
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
注意事项：
分页查询：当前查询结果以分页形式进行展示，单次查询最多显示50条数据
接口约束
1. 使用限制，本接口只支持在部分资源池进行公测
URI
POST /v4/ecs/lite/list
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
aaf589124d5d11eaa04d0242ac110002 | |
| pageNo | 否 | Integer | 页码，取值范围：正整数（≥1），注：默认值为1 | 1 | |
| pageSize | 否 | Integer | 每页记录数目，取值范围：[1, 50]，注：默认值为10 | 10 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 | |
| errorCode | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| error | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| message | String | 失败时的错误描述，一般为英文描述 | SUCCESS | |
| description | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| currentCount | Integer | 当前页记录数目 | 1 | |
| totalCount | Integer | 总记录数 | 10 | |
| totalPage | Integer | 总页数 | 1 | |
| results | Array of Objects | 分页明细 | results |
表 results
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| resourceID | String | 云主机资源ID | f88bc88a88a888e8a88bf88888888888 | |
| instanceID | String | 云主机ID | 88f888ea-88ff-88ec-a8bc-888888888fe8 | |
| displayName | String | 云主机显示名称 | xxx-8888 | |
| instanceName | String | 云主机名称 | xxx-8888 | |
| osType | Integer | 操作系统类型，取值范围： 1: linux， 2: windows， 3: redhat， 4: ubuntu， 5: centos， 6: oracle |
5 | |
| instanceStatus | String | 云主机状态，取值范围： backingup: 备份中， creating: 创建中， expired: 已到期， freezing: 已冻结， rebuild: 重装， restarting: 重启中， running: 运行中， starting: 开机中， stopped: 已关机， stopping: 关机中， error: 错误， snapshotting: 快照创建中。 更多云主机状态请通过状态枚举值查看云主机使用状态 |
running | |
| expiredTime | String | 到期时间 | 2023-04-19T09:37:53Z | |
| createdTime | String | 创建时间 | 2022-10-19T09:37:53Z | |
| addresses | Object | 网络地址信息 | addresses | |
| image | Object | 镜像信息 | image | |
| flavor | Object | 规格信息 | flavor | |
| bandwidth | Integer | 带宽 | 2 | |
| bootDiskSize | Integer | 系统盘大小 | 40 |
表 addresses
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| addressList | Array of Objects | 网络地址列表 | addressList |
表 image
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| imageID | String | 镜像ID | b88888b8-ff88-8888-b88f-8c8fbc888b88 | |
| imageName | String | 镜像名称 | CentOS7.5.v1-20210303 |
表 flavor
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| flavorID | String | 规格ID | 8f8ba888-88e8-ea88-ea8b-888888dded88 | |
| flavorName | String | 规格名称 | s7.medium.2 | |
| flavorCPU | Integer | VCPU | 1 | |
| flavorRAM | Integer | 内存 | 2048 |
表 addressList
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| addr | String | 地址 | 192.168.0.62 | |
| version | Integer | IP版本 | 4 | |
| type | String | 网络类型 | fixed |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "aaf589124d5d11eaa04d0242ac110002",
"pageNo": 1,
"pageSize": 1
}
响应示例
{
"returnObj": {
"currentCount": 1,
"totalCount": 1,
"totalPage": 1,
"results": [{
"instanceStatus": "running",
"displayName": "LiteECS-cafd",
"addresses": {
"addressList": [{
"version": 4,
"type": "fixed",
"addr": "172.31.1.8"
}, {
"version": 4,
"type": "floating",
"addr": "100.127.12.88"
}]
},
"instanceID": "7a9acf36-ed22-49e4-8ca2-a9ab6021e8a2",
"resourceID": "ad2ba3d200e54e00850f7f7f9f35205c",
"image": {
"imageName": "CentOS7.6.v1-20020301",
"imageID": "dca942b0-e934-4bd5-b5c1-4f5e1aad56a6"
},
"createdTime": "2023-07-03T06:47:04Z",
"bandwidth": 10,
"expiredTime": "2023-10-03T06:47:04Z",
"bootDiskSize": 80,
"osType": 5,
"flavor": {
"flavorCPU": 4,
"flavorID": "6c76c383-586c-4302-aeff-2f891734e8e4",
"flavorRAM": 8192,
"flavorName": "lite1.band.xlarge.2"
},
"instanceName": "VM-79ab13b6"
}]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
