查询规格模板列表v3
更新时间 2025-07-29 19:00:44
最近更新时间: 2025-07-29 19:00:44
接口功能介绍
查询规格模板列表v3
接口约束
无
URI
GET /v3/desktopTemplate/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。 | ||
processorType | 否 | String | 处理器类型。仅对XC型规格有意义。默认为kp。取值范围: - kp:鲲鹏。 - hg:海光。 - ft:飞腾。 - zx:兆芯。 - Intel:Intel。 |
||
billMode | 否 | String | 计费方式。枚举值[ResBag-资源包,Cycle-包月计费,OnDemand-按需计费],默认为ResBag | ||
graphicsCardType | 否 | String | 显卡类型。仅对GPU型规格有意义。枚举值[Nvidia-英伟达,AMD-AMD,Intel-英特尔,MOORE-摩尔线程],默认全部 | ||
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
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
templateOid | String | 规格模板ID。 | ||
templateName | String | 规格模板名称。 | ||
cpu | Integer | CPU核心数。 | ||
memory | Integer | 内存大小(单位:GB)。 | ||
gpuMemory | Integer | 显存大小(单位:GB)。 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{
"statusCode":800,
"message":"OK.",
"returnObj":{
"total":1,
"list":[{
"templateOid":"fooId",
"templateName":"2核4GB",
"cpu":2,
"memory":4
}]
}
}
状态码
请参考 状态码
错误码
请参考 错误码