接口功能介绍
查询可用公共镜像列表
接口约束
无
URI
GET /v3/systemImage/describe
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池ID。 | d8bbd132b53a11e9b0e40242ac110002 | |
| platform | 否 | String | 操作系统平台（Windows;Centos;Ubuntu;UOS;Kylin-银河麒麟;NeoKylin-中标麒麟） | Centos | |
| osName | 否 | String | 操作系统名称 | hhj云服务器 | |
| 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 | 总记录数 | 20 | |
| list | Array of Objects | 数据列表 | list |
表 list
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| imageOid | String | 镜像ID | mi-i4ri4afb4inm29d52o85d | |
| imageName | String | 镜像名称 | hhj云服务器-v1.0 | |
| osName | String | 操作系统名称 | hhj云服务器 | |
| osType | String | 操作系统类型（Windows;Linux） | Linux | |
| platform | String | 操作系统平台（Windows;Centos;Ubuntu;UOS;Kylin-银河麒麟;NeoKylin-中标麒麟） | Centos | |
| sysDisk | Object | 系统盘相关信息 | sysDisk | |
| gpuCategory | Boolean | 是否为GPU类型镜像 | false | |
| updateTime | String | 修改时间。以ISO 8601为标准，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。 | 2023-09-13T10:08:06Z |
表 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},"gpuCategory":false,"updateTime":"2022-03-04T01:42:07Z"}]}}
状态码
请参考 状态码
错误码
请参考 错误码
