镜像服务

查询镜像详细信息

接口功能介绍

根据镜像 ID，查询一份镜像的详细信息。

推荐使用查询物理机可支持的镜像接口来查询物理机镜像。

接口约束

无

URI

GET /v4/image/detail

路径参数

无

Query参数

参数	是否必填	参数类型	描述	示例	下级对象
imageID	是	String	镜像 ID。可使用查询可以使用的镜像资源接口来查询您可使用的镜像资源。	8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa
regionID	是	String	资源池 ID。可使用资源池列表查询接口来查询您可见的资源池的列表。	88f8888888dd88ec888888888d888d8b

请求参数

请求头header参数

无

请求体body参数

无

响应参数

参数	是否必填	参数类型	描述	示例	下级对象
statusCode	是	Integer	返回状态码，取值范围（值：描述）： 800：成功 900：失败	800
errorCode	是	String	错误码（product.module.code 三段式码）。
message	是	String	失败时的错误描述（一般为英文）。
description	是	String	失败时的错误描述（一般为中文）。
returnObj	是	Object	返回参数。		returnObj

表 returnObj

参数	是否必填	参数类型	描述	示例	下级对象
images	是	Array of Objects	镜像列表，应包含 1 个镜像。		image

表 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	镜像可见类型，取值范围（值：描述）： private：私有镜像 public：公共镜像 shared：共享镜像 safe：安全产品镜像 community：甄选应用镜像 app：应用镜像

请求示例

请求头header

无

请求体body

{
  "imageID": "8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa",
  "regionID": "88f8888888dd88ec888888888d888d8b"
}

响应示例

{
  "statusCode": 800,
  "errorCode": "",
  "message": "",
  "description": "",
  "returnObj": {
    "images": [
      {
        "architecture": "x86_64",
        "azName": null,
        "bootMode": "bios",
        "containerFormat": "bare",
        "createdTime": 1664409600,
        "description": "Test CentOS",
        "destinationUser": null,
        "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": 0,
        "size": 42949672960,
        "sourceServerID": "88f888ea-88ff-88ec-a8bc-888888888fe8",
        "sourceUser": null,
        "status": "active",
        "tags": null,
        "updatedTime": 1664409600,
        "visibility": "private"
      }
    ]
  }
}

状态码

状态码	描述
200	表示请求成功。

错误码

错误码	描述
Image.ImageAdmin.AccessFailed Image.ImageWorkorder.AccessFailed	内部错误，请重试。如果多次尝试失败，请提交工单。
Image.ImageCheck.NotFound	镜像不存在或不符合要求。
Image.RegionInfo.AccessFailed	查询资源池失败。
Image.RegionInfo.DataDamaged	资源池信息不符预期。
Image.RegionInfo.Empty	资源池信息为空或资源池不存在。
Openapi.PatternCheck.NotValid	请求参数无效。

重要变更历史

2023-10-30

支持查询应用镜像详细信息。

2023-07-03

变更错误码，增加资源池相关的错误码。

智算服务

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

查看所有产品

镜像服务

查询镜像详细信息

接口功能介绍

接口约束

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

重要变更历史

2023-10-30

2023-07-03

活动

智算服务

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

查看所有产品

镜像服务

镜像服务

查询镜像详细信息

接口功能介绍

接口约束

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

重要变更历史

2023-10-30

2023-07-03