接口功能介绍
查询镜像列表信息
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
注意事项：
全量查询：该接口为全量查询，不支持分页查询
接口约束
无
URI
GET /v4/cthpc/list-image
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 查询支持超算的地域列表 |
8e3a382e241d11ed957c0242ac110006 | |
| imageUUIDList | 否 | String | 镜像UUID列表, 以逗号分隔 | uuid-1,uuid-2 | |
| clusterTypeUUID | 否 | String | 对应集群类型UUID 获取： 查 查询集群类型列表 |
uuid-1 | |
| nodeRole | 否 | Integer | 节点角色, 0: master, 1:compute | 0 | |
| nodeType | 否 | Integer | 节点类型，目前只能是0，代表bm(裸金属服务器)，未来可能会添加vm、gpu等 | 0 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800 为成功，900 为失败） | 800 | |
| errorCode | String | 错误码，为product.module.code 三段式码 | Hpc.Image.NotValid | |
| error | String | 错误码，为product.module.code 三段式码 | Hpc.Image.NotValid | |
| message | String | 失败时的英文错误描述 | Param is null | |
| description | String | 失败时的中文错误描述 | 请求为空 | |
| returnObj | Object | 返回参数 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| totalCount | Integer | 镜像总数，因为无分页，所以无currentCount和totalPage | 2 | |
| resultList | Array of Objects | 结果列表 | result |
表 result
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| imageUUID | String | 镜像实例UUID | im-3mr8m4j8wowockmp2mo3bfstzyzu | |
| regionName | String | 资源池名称 | cn-anshun-t1 | |
| azName | String | 可用区 | cn-anshun-t1a | |
| resourceImageUUID | String | 装机镜像UUID， 如下单开裸机所用装机的镜像 | im-zixfrrdb5zju8y4a5jxofodjtbsb | |
| osName | String | 系统名称 | centos | |
| osVersion | String | 系统版本号 | 7.6 | |
| clusterTypeUUID | String | 集群类型UUID | ct-jn8sm0bejygcdglhpljbddjll9ro | |
| nodeRole | Integer | 节点角色, 取值范围如下： 0: master 1: compute |
0 | |
| nodeType | Integer | 节点类型，0: bm(裸金属服务器) | 0 | |
| createTime | String | 创建时间 | 2022-10-19 17:40:07 |
枚举参数
无
请求示例
请求url
示例：查询内蒙6资源池的镜像列表
/v4/cthpc/list-image?regionID=6019b5007a0b11eab5db0242ac110002
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"totalCount": 2,
"resultList": [
{
"nodeType": 0,
"osName": "centOS",
"regionName": "cn-anshun-t1",
"clusterTypeUUID": "ct-jn8sm0bejygcdglhpljbddjll9ro",
"osVersion": "7.6",
"nodeRole": 0,
"azName": "cn-anshun-t1a",
"resourceImageUUID": "im-zixfrrdb5zju8y4a5jxofodjtbsb",
"createTime": "2022-10-19 17:40:07",
"imageUUID": "im-3mr8m4j8wowockmp2mo3bfstzyzu"
},
{
"nodeType": 0,
"osName": "centOS",
"regionName": "cn-anshun-t1",
"clusterTypeUUID": "ct-jn8sm0bejygcdglhpljbddjll9ro",
"osVersion": "7.6",
"nodeRole": 1,
"azName": "cn-anshun-t1a",
"resourceImageUUID": "im-qx68ocnwfmfqynsuacfmdnmfcq6j",
"createTime": "2022-10-19 17:38:16",
"imageUUID": "im-ckpyqfhbdkkacij5zfsn04b7ahug"
}
]
},
"errorCode": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
