接口功能介绍

返回适合用于创建云电脑的镜像

接口约束

无

URI

GET /v3/image/describe

路径参数
无

Query参数

参数	是否必填	参数类型	说明	示例
regionId	是	String	资源池ID。	xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
osType	否	String	系统类型。枚举值范围：[Windows, Linux]，默认为Windows
flavorType	否	String	规格类型。枚举值范围：[Common-通用型, Gpu-GPU型, Xc-XC型]，默认为Common。
flavorSubtype	否	String	规格子类型。仅对资源包模式Linux通用型规格云电脑有意义。枚举值范围：[Desktop-桌面版, Server-服务器版]，默认为Desktop。
cpuArch	否	String	CPU架构。仅对XC型规格有意义。枚举值范围：[arm, x86]，默认为arm。
billMode	否	String	计费方式。枚举值[ResBag-资源包，Cycle-包月计费，OnDemand-按需计费]，默认为ResBag.
processorType	否	String	处理器类型。仅对XC型规格有意义。默认为kp。取值范围： - kp：鲲鹏。 - hg：海光。 - ft：飞腾。 - zx：兆芯。 - Intel：Intel。
pageNum	否	Integer	页码，至少1，默认1
pageSize	否	Integer	每页数量，最大100，默认10

请求参数

请求头header参数
无

请求体body参数
无

响应参数

参数	参数类型	说明	示例	下级对象
statusCode	Integer	状态码。可能值： - 800：请求成功。 - 900：请求失败。	800
error	String	错误码。	ECPC_1000
message	String	提示信息。	OK.
returnObj	Object	返回数据对象		returnObj

表 returnObj

参数	参数类型	说明	示例	下级对象
total	Long	总记录数
list	Array of Objects	数据列表		list

表 list

参数	参数类型	说明	下级对象
imageOid	String	镜像ID
imageName	String	镜像名称
osName	String	操作系统名称
osType	String	操作系统类型（Windows;Linux）
platform	String	操作系统平台（Windows;Centos;Ubuntu;UOS;Kylin-银河麒麟;NeoKylin-中标麒麟）
sysDisk	Object	系统盘相关信息	sysDisk

表 sysDisk

参数	参数类型	说明	示例	下级对象
diskSize	Integer	盘大小（单位：GB）

枚举参数

无

请求示例

请求url

无

请求头header

无

请求体body

无

响应示例

{
  "statusCode":800,
  "message":"OK.",
  "returnObj":{
    "total":1,
    "list":[{
      "imageOid":"mi-xxx",
      "imageName":"Windows-2016-Standard-x64-Chinese-vX.XX",
      "osName":"Windows 2016 Standard 64位 中文版",
      "osType":"Windows",
      "platform":"Windows",
      "sysDisk":{
        "diskSize":80
      }
    }]
  }
}

状态码

请参考状态码

错误码

请参考错误码

智算服务

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

天翼云电脑（政企版）

天翼云电脑（政企版）

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码

活动

智算服务

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

天翼云电脑（政企版）

天翼云电脑（政企版）

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码