接口功能介绍
- 返回适合用于创建云电脑的镜像
接口约束
无
URI
GET /v3/image/describe
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池ID。 | d8bbd132b53a11e9b0e40242ac110002 | |
| osType | 否 | String | 系统类型。枚举值范围：[Windows]，默认为Windows | Windows | |
| flavorType | 否 | String | 规格类型。枚举值范围：[Common-通用型, Gpu-GPU型]，默认为Common | Common | |
| pageNum | 否 | Integer | 页码，至少1，默认1 | 1 | |
| pageSize | 否 | Integer | 每页数量，最大100，默认10 | 10 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码。可能值： - 800：请求成功。 - 900：请求失败。 |
800 | |
| error | String | 错误码。 | ||
| message | String | 提示信息。 | OK. | |
| returnObj | Object | 返回数据对象 | { } | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total | Long | 总记录数 | 7 | |
| list | Array of Objects | 数据列表 | list |
表 list
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| imageOid | String | 镜像ID | mi-p4ij5apxcvse44qid3kec | |
| imageName | String | 镜像名称 | Windows-2016-Standard-x64-Chinese-v1.0 | |
| osName | String | 操作系统名称 | Windows 2016 Standard 64位 中文版（生产）（推荐） | |
| osType | String | 操作系统类型（Windows;Linux） | Windows | |
| platform | String | 操作系统平台（Windows;Centos;Ubuntu;UOS;Kylin-银河麒麟;NeoKylin-中标麒麟） | Windows | |
| sysDisk | Object | 系统盘相关信息 | sysDisk |
表 sysDisk
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| diskSize | Integer | 盘大小（单位：GB） | 80 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{"statusCode":800,"message":"OK.","returnObj":{"total":1,"list":[{"imageOid":"mi-xxx","imageName":"Windows-2016-Standard-x64-Chinese-vX.XX","osName":"Windows 2016 Standard 64位 中文版","osType":"Windows","platform":"Windows","sysDisk":{"diskSize":80}}]}}
状态码
请参考 状态码
错误码
请参考 错误码
