API文档
云服务器相关接口
产品类型接口
查询镜像

1. 查询镜像

本接口用于查询镜像信息。

  1. 本接口返回发布给访问用户的所有镜像信息。
  2. 本接口不是分页接口,可以一次性获取所有发布给访问用户的镜像信息。

本页所有接口都用到可用区信息,可用区具体说明详见 可用区, 本页不再重复说明

1.1. 接口说明

本接口所属服务类型为 product

本接口操作类型为 DescribeImages

1.1.1. 请求路径

POST {baseUrl}/v3/product/DescribeImages

返回内容

{
	"code": 200,
	"data": [{
		"imageArch": "64bit",
		"imageDesc": "操作系统:Ubuntu20.04",
		"imageId": "636bc998-9382-47e9-9573-6dbac34abda7",
		"imageName": "GT-Ubuntu20.04-CMD-V2.0",
		"imageOs": "Ubuntu",
		"imageType": "custom",
		"imageVersion": "20.04",
		"vhostType": "cpu,ecpu",
		"zone": {
			"regionCode": "cn-zhongwei",
			"regionName": "中卫",
			"zoneCode": "cn-zhongwei-a",
			"zoneName": "中卫一区"
		}
	}],
	"message": "查询镜像资源成功"
}

返回内容说明

属性名属性类型说明
codeInteger返回码。正常返回 200,异常返回500或其他业务错误码
messageString返回信息
dataArray发布给该用户镜像规格信息列表

镜像信息列表

属性名属性类型说明
imageIdString镜像id
imageNameString镜像名称
imageTypeString镜像类型。目前只有一个值 custom
imageOsString镜像的操作系统名称
imageVersionString镜像版本
imageArchString镜像支持的架构
imageDescString镜像描述信息
minDiskSizeInteger镜像要求的最小磁盘大小
vhostTypeString镜像支持的云服务器规格类型。逗号分割
zoneZone镜像规格所属可用区信息