接口功能介绍
查询自定义镜像列表
接口约束
无
URI
GET /v3/customImage/describe
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池ID。 | d8bbd132b53a11e9b0e40242ac110002 | |
| imageName | 否 | String | 镜像名称 | DYF | |
| status | 否 | String | 状态。枚举值范围：[Starting-启用中, Available-可用, Stopped-停用, StartFailed-启用失败, Uploading-上传中, UploadFailed-上传失败, WaitVerify-待验证, Expired-已过期, Deleting-删除中, DeleteFailed-删除失败]。 | Available | |
| pageNum | 否 | Integer | 页码，至少1，默认1 | 1 | |
| pageSize | 否 | Integer | 每页数量，最大100，默认10 | 10 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码。可能值： - 800：请求成功。 - 900：请求失败。 |
800 | |
| error | String | 错误码。 | ECPC_1000 | |
| message | String | 提示信息。 | ok | |
| returnObj | Object | 返回数据对象 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total | Long | 总记录数 | 2 | |
| list | Array of Objects | 数据列表 | list |
表 list
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| imageOid | String | 镜像ID | mi-lm91642m8ukk1r7a6h7l5 | |
| imageName | String | 镜像名称 | Windows-Server-2019-Standard-v1.3 | |
| osType | String | 操作系统类型（Windows;Linux） | Windows | |
| platform | String | 操作系统平台（Windows;Centos;Ubuntu;UOS;Kylin-银河麒麟;NeoKylin-中标麒麟） | Windows | |
| sysDisk | Object | 系统盘相关信息 | sysDisk | |
| dataDisks | Array of Objects | 数据盘相关信息列表 | dataDisks | |
| description | String | 描述 | 测试 | |
| gpuCategory | Boolean | 是否为GPU类型镜像 | false | |
| status | String | 状态。枚举值范围：[Starting-启用中, Available-可用, Stopped-停用, StartFailed-启用失败, Uploading-上传中, UploadFailed-上传失败, WaitVerify-待验证, Expired-已过期, Deleting-删除中, DeleteFailed-删除失败]。 | Available | |
| createTime | String | 创建时间。以ISO 8601为标准，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。 | 2023-09-27T07:48:41Z | |
| expireTime | String | 到期时间。以ISO 8601为标准，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。 | null |
表 sysDisk
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| diskSize | Integer | 盘大小（单位：GB） | 80 |
表 dataDisks
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| diskSize | Integer | 盘大小（单位：GB） | 20 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{"statusCode":800,"message":"OK.","returnObj":{"total":1,"list":[{"imageOid":"mi-xxx","imageName":"xxx","osType":"Windows","platform":"Windows","sysDisk":{"diskSize":80},"dataDisks":[ ],"description":"","gpuCategory":false,"status":"Available","createTime":"2022-03-10T07:04:59Z","expireTime":"2026-01-11T02:27:53Z"}]}}
状态码
请参考 状态码
错误码
请参考 错误码
