查询共享镜像列表
更新时间 2026-01-22 16:39:12
最近更新时间: 2026-01-22 16:39:12
接口功能介绍
查询共享镜像列表。
接口约束
无
URI
GET /v3/shareImage/describe
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池ID | rg-1234567890abcdef1234567890abcd | |
| imageName | 否 | String | 镜像名称 | centos-7.9 | |
| status | 否 | String | 镜像状态。可选值：Sharing-共享中，Shared-已共享，Pending-待接受共享，Declined-拒绝共享 | Sharing | |
| pageNum | 否 | Integer | 页码，默认1 | 1 | |
| pageSize | 否 | Integer | 每页数量，默认10 | 10 |
请求参数
请求头header参数 无
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| code | Integer | 状态码 | ||
| msg | String | 响应消息 | ||
| data | Object | 返回数据 | data | |
| 表 data |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total | Integer | 总记录数 | ||
| list | Array of Objects | 镜像列表 | list | |
| 表 list |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| imageOid | String | 镜像ID | ||
| imageName | String | 镜像名称 | ||
| osType | String | 操作系统类型 | ||
| platform | String | 平台类型 | ||
| sysDisk | Object | 系统盘信息 | sysDisk | |
| dataDisks | Array of Objects | 数据盘列表 | dataDisks | |
| description | String | 镜像描述 | ||
| gpuCategory | Boolean | 是否GPU镜像 | ||
| status | String | 镜像状态 | ||
| createTime | String | 创建时间 | ||
| expireTime | String | 过期时间 | ||
| 表 sysDisk |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| diskSize | Integer | 磁盘大小(GB) | ||
| 表 dataDisks |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| diskSize | Integer | 磁盘大小(GB) |
枚举参数
无
请求示例
请求url
https://{host}?regionId=rg-1234567890abcdef1234567890abcd&imageName=centos-7.9&status=Sharing&pageNum=1&pageSize=10
请求头header
无
请求体body
无
响应示例
{
"code":0,
"data":{
"total":1,
"list":[{
"imageOid":"XXXXXXXXXXXX",
"imageName":"XXXXXXXXXXXX",
"osType":"Windows",
"platform":"Windows",
"sysDisk":{
"diskSize":80
},
"dataDisks":[ ],
"description":"XXXXXXXXXXXX",
"gpuCategory":false,
"status":"Starting",
"createTime":"XXXXXXXXXXXX",
"expireTime":"XXXXXXXXXXXX"
}]
}
}
状态码
请参考 状态码
错误码
请参考 错误码
