接口功能介绍
查询一份私有镜像的共享列表。
在您将一份私有镜像共享给其他用户之后,此接口可用于查询该私有镜像的共享列表。若需要查询您的共享镜像(其他用户共享给您),则可使用查询可以使用的镜像资源接口。
接口约束
无
URI
GET /v4/image/show-shared-list
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
imageID | 是 | String | 镜像 ID。可使用查询可以使用的镜像资源接口来查询您可使用的镜像资源。 | 8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa | |
regionID | 是 | String | 资源池 ID。可使用资源池列表查询接口来查询您可见的资源池的列表。 | 88f8888888dd88ec888888888d888d8b | |
pageNo | 否 | String | 页码,取值范围:最小 1(默认值)。 | 1 | |
pageSize | 否 | String | 每页记录数目,取值范围:最小 1,最大 50,默认值 10。 | 10 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码,取值范围(值:描述): 800:成功 900:失败 |
800 | |
error | String | 错误码(product.module.code 三段式码)。 | ||
errorCode | String | 同“error”参数。 | ||
message | String | 响应状态描述(一般为英文)。 | ||
description | String | 响应状态描述(一般为中文)。 | ||
returnObj | Object | 返回参数。 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
images | Array of Objects | 镜像列表。 | image | |
pageNo | Integer | 当前页码。注意:此参数即将弃用。若有获取当前页码需要,则请使用 currentPage。 | 1 | |
currentPage | Integer | 当前页码。 | 1 | |
pageSize | Integer | 当前页记录数目。注意:此参数即将弃用。若有获取当前页记录数目需要,则请使用 currentCount。 | 10 | |
currentCount | Integer | 当前页记录数目。 | 10 | |
totalCount | Integer | 总记录数。 | 1 |
表 image
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
architecture | String | 镜像系统架构,取值范围(值:描述): aarch64:AArch64 架构,仅支持 UEFI 启动方式 x86_64:x86_64 架构,支持 BIOS 和 UEFI 启动方式 |
x86_64 | |
azName | String | 可用区名称。 | az1 | |
bootMode | String | 启动方式,取值范围(值:描述): bios:BIOS 启动方式 uefi:UEFI 启动方式 |
bios | |
containerFormat | String | 容器格式。 | bare | |
createdTime | Integer | 镜像创建时间,epoch 秒数,即从 1970-01-01 00:00:00 UTC 到当前时间的秒数。 | 1664409600 | |
description | String | 镜像描述信息。 | Test CentOS | |
destinationUser | String | 共享镜像的接受人。 | 888888@chinatelecom.cn | |
diskFormat | String | 磁盘格式,取值范围(值:描述): qcow2:QCOW2 格式 raw:RAW 格式 vhd:VHD 格式 vmdk:VMDK 格式 |
raw | |
diskID | String | 私有镜像来源的系统盘/数据盘 ID。 | 8888a888-b888-8888-a888-baee8d8ce88c | |
diskSize | Integer | 磁盘容量,单位为 GB。 | 40 | |
imageClass | String | 镜像类别,取值范围(值:描述): BMS:物理机 ECS:云主机 |
ECS | |
imageID | String | 镜像 ID。 | 8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa | |
imageName | String | 镜像名称。 | CentOS-test | |
imageType | String | 镜像类型,取值范围(值:描述): (空或空字符串):系统盘镜像 data_disk_image:数据盘镜像 |
||
maximumRAM | Integer | 最大内存。 | 0 | |
minimumRAM | Integer | 最小内存。 | 0 | |
osDistro | String | 操作系统的发行版名称。 | centos | |
osType | String | 操作系统类型,取值范围(值:描述): linux:Linux 系操作系统 windows:Windows 系操作系统 |
linux | |
osVersion | String | 操作系统版本。 | 7.8 | |
projectID | String | 项目 ID。 | 0 | |
sharedListLength | Integer | 私有镜像的共享列表的总记录数。 | 0 | |
size | Integer | 镜像大小,单位为 byte。 | 42949672960 | |
sourceServerID | String | 私有镜像来源的云主机/物理机 ID。 | 88f888ea-88ff-88ec-a8bc-888888888fe8 | |
sourceUser | String | 共享镜像的发起人。 | 777777@chinatelecom.cn | |
status | String | 镜像状态,取值范围(值:描述): accepted:已接受共享镜像 active:正常 deactivated:已弃用 deactivating:弃用中 deleted:已删除 deleting:删除中 error:错误 importing:导入中 killed:上传出错,镜像不可读 pending_delete:等待删除中 queued:排队中 reactivating:取消弃用中 rejected:已拒绝共享镜像 saving:保存中 syncing:同步中 uploading:上传中 waiting:等待接受/拒绝共享镜像 |
waiting | |
tags | String | 标签。一种场景是标记公共 GPU 镜像适用规格。 | ||
updatedTime | Integer | 镜像更新时间,epoch 秒数,即从 1970-01-01 00:00:00 UTC 到当前时间的秒数。 | 1664409600 | |
visibility | String | 镜像可见类型,应始终为 shared(共享镜像)。 | shared |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"imageID": "8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa",
"regionID": "88f8888888dd88ec888888888d888d8b",
"pageNo": 1,
"pageSize": 10
}
响应示例
{
"statusCode": 800,
"errorCode": "",
"message": "SUCCESS",
"description": "成功",
"returnObj": {
"images": [
{
"architecture": "x86_64",
"azName": null,
"bootMode": "bios",
"containerFormat": "bare",
"createdTime": 1664409600,
"description": "Test CentOS",
"destinationUser": "888888@chinatelecom.cn",
"diskFormat": "raw",
"diskID": "8888a888-b888-8888-a888-baee8d8ce88c",
"diskSize": 40,
"imageClass": "ECS",
"imageID": "8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa",
"imageName": "CentOS-test",
"imageType": "",
"maximumRAM": 0,
"minimumRAM": 0,
"osDistro": "centos",
"osType": "linux",
"osVersion": "7.8",
"projectID": "0",
"sharedListLength": null,
"size": 42949672960,
"sourceServerID": "88f888ea-88ff-88ec-a8bc-888888888fe8",
"sourceUser": "777777@chinatelecom.cn",
"status": "waiting",
"tags": null,
"updatedTime": 1664409600,
"visibility": "shared"
}
],
"pageNo": 1,
"currentPage": 1,
"pageSize": 1,
"currentCount": 1,
"totalCount": 1
}
}
状态码
请参考 状态码
错误码
请参考 错误码