接口功能介绍
查询规格模板列表
接口约束
无
URI
GET /v3/desktopTemplate/describe
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池ID。 | d8bbd132b53a11e9b0e40242ac110002 | |
osType | 否 | String | 系统类型。枚举值范围:[Windows],默认为Windows | Windows | |
flavorType | 否 | String | 规格类型。枚举值范围:[Common-通用型, Gpu-GPU型],默认为Common | Gpu | |
pageNum | 否 | Integer | 页码,至少1,默认1 | 1 | |
pageSize | 否 | Integer | 每页数量,最大100,默认10 | 10 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 状态码。可能值: - 800:请求成功。 - 900:请求失败。 |
800 | |
error | String | 错误码。 | ECPC_1000 | |
message | String | 提示信息。 | ok | |
returnObj | Object | 返回数据对象 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
total | Long | 总记录数 | 8 | |
list | Array of Objects | 数据列表 | list |
表 list
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
templateOid | String | 规格模板ID。 | dft-h0h8xlci549ih42a5d7if | |
templateName | String | 规格模板名称。 | 4C8G2Q( Nvidia T4 ) | |
cpu | Integer | CPU核心数。 | 4 | |
memory | Integer | 内存大小(单位:GB)。 | 8 | |
gpuMemory | Integer | 显存大小(单位:GB)。 | 2 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{"statusCode":800,"message":"OK.","returnObj":{"total":1,"list":[{"templateOid":"fooId","templateName":"2核4GB","cpu":2,"memory":4}]}}
状态码
请参考 状态码
错误码
请参考 错误码