查询指定电脑可用镜像列表

接口说明

开放政企版给电脑查询指定电脑可用镜像列表 业务逻辑:支持通过电脑ID查询给电脑可用的镜像列表,用于切换镜像的查看可使用的镜像,列表信息包括:镜像名称、镜像ID、镜像范围、系统盘(GB)、镜像类型、操作系统、资源池、可用区、网络工作区。 ,支持分页查询(单页默认10,最大50)。 限流:根据租户实现用户级别的限流,限制为10次每秒


推荐使用API Explorer调试

API Explorer支持接口在线可视化调用,同时自动生成动态代码示例,搭配OpenAPI SDK无需计算签名实现接口快速集成。

URL

POST https://ecloud.10086.cn/api/clouddesktopnew/cem_openapi/ccacem/api/v1/image/getMachineImageUsage

请求参数

Body

参数名称
类型
必填
描述
reqDto
GetMachineImageOpenApiReqDto
是

请求入参

machineId
string
是

云电脑id

currentPage
integer(int32)
否

当前页

pageSize
integer(int32)
否

每页显示条数

请求示例

POST https://ecloud.10086.cn/api/clouddesktopnew/cem_openapi/ccacem/api/v1/image/getMachineImageUsage
{
	"machineId":"07562dd1f-1d04-4161-9c3a-b36a269d2a50",
	"currentPage":1,
	"pageSize":10
}

返回参数

返回码:200
OK
参数名称
类型
描述
body
PageReturnEntity«TenantListImageRespDto»

请求成功时返回的数据

data
<TenantListImageRespDto> array

数据

companyName
string

厂商名称,例如:新华三

createdTime
string

创建时间

dc
string

dc,例如:ONEDAAS-SERVICE-0002

diskType
string

磁盘性质,仅系统盘(system)

errorCode
string

底层返回的错误码

errorMessage
string

底层返回的错误信息

imageId
string

镜像模板主键ID

imageName
string

镜像模板名称

imageOs
string

镜像操作系统,当前版本仅支持(windows)

imageRemark
string

镜像模板描述

imageStatus
string

镜像状态,creating:创建中,create:创建完成,createError:创建失败,deleting:删除中,deleted:已删除,deletedError:删除失败

imageTarget
string

镜像模板范围,系统及数据盘(all)、仅系统盘(system)

imageType
string

镜像类型,自定义镜像:custom,共享镜像:share

modifiedTime
string

修改时间

poolCode
string

资源池编码,例如:CIDC-RP-35

poolName
string

资源池名称,例如:华东-杭州

region
string

可用区,例如:CIDC-RP-35-AZ1

regionName
string

可用区名称,例如:可用区一

requestId
string

和底层交互的requestId

responseMsg
string

底层最近一次交互返回的信息

sysDiskSize
string

系统盘大小,单位GB

templateId
string

镜像模板UID

totalCount
integer(int32)

总行数

errorCode
string

统一错误码

errorMessage
string

错误码提示信息

requestId
string

每个请求的序列号

state
enum(OK,ERROR,EXCEPTION,FORBIDDEN,REMAINING,TIMEOUT)

返回状态码;返回正常:OK,返回错误:ERROR,返回异常:EXCEPTION,需要告警实现的:ALARM,禁止访问:FORBIDDEN

返回示例

返回码:200
OK
{
	"state":"OK",
	"body":{
		"data":[
			{
				"imageId":"1922930348829298690",
				"templateId":"06ed323a-03fe-46e8-a618-0b8bacd3aac4",
				"imageName":"a111",
				"imageRemark":"",
				"poolCode":"CIDC-RP-25",
				"poolName":"华东-苏州",
				"companyName":"中兴",
				"region":"CIDC-CORE-00",
				"regionName":"可用区一",
				"dc":"VMC151-new",
				"imageStatus":"create",
				"imageType":"custom",
				"imageTarget":"system",
				"diskType":"system",
				"sysDiskSize":"80",
				"imageOs":"windows 10",
				"responseMsg":null,
				"createdTime":"2025-05-15 16:21:36",
				"modifiedTime":"2025-05-15 16:25:17",
				"errorMessage":"",
				"errorCode":null,
				"requestId":null
			}
		],
		"totalCount":1
	},
	"errorCode":"200",
	"errorMessage":"",
	"requestId":"4edde75a84babc16"
}
本文档内容整理自移动云官方帮助中心(查看原文),仅供参考。