获取桌面列表接口

接口说明

面向政企版租户开放获取桌面列表接口 限流:根据租户实现用户级别的限流,限制为100次每秒


推荐使用API Explorer调试

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

URL

POST https://ecloud.10086.cn/api/Computer_api/cem_openapi/ccacem/api/v1/resource/getVmList

请求参数

Body

参数名称
类型
必填
描述
reqDto
使用accessToken接口基本入参
是
accessToken
string
是

accessToken

请求示例

POST https://ecloud.10086.cn/api/Computer_api/cem_openapi/ccacem/api/v1/resource/getVmList
{
	"accessToken":"token:1802895785631600642:3555e39e181c4713b0e0393695a03398accountPwd"
}

返回参数

返回码:200
OK
参数名称
类型
描述
body
获取登录用户桌面列表接口出参

请求成功时返回的数据

machineList
<Desktop> array

桌面信息列表

connectInfo
string

连接信息

machineId
string

桌面ID

machineName
string

桌面名称

resourceStatus
string

桌面状态 available 运行中 shutdown 已关机 onShutdown 关机中 onAvailable 开机中 onReload 重装中 onRestart 重启中 exception 异常 imageCreating 镜像制作中 snapshotCreating 快照制作中 transferring 迁移中 freeze 已分配-冻结 alter 已分配-变更中

resourceStatusCn
string

桌面状态描述 运行中 已关机 关机中 开机中 重装中 重启中 异常 镜像制作中 快照制作中 迁移中 已分配-冻结 已分配-变更中

errorCode
string

统一错误码

errorMessage
string

错误提示信息

requestId
string

每个请求的序列号

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

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

返回示例

返回码:200
OK
{
	"body":{
		"machineList":[
			{
				"connectInfo":"+i0mGHoXykLQzE2zk9MEO3lnaLnEJfbW",
				"machineId":"417bf8be-e377-472e-968c-8e0002320ccb",
				"machineName":"我的电脑",
				"resourceStatus":"available",
				"resourceStatusCn":"开机"
			}
		]
	},
	"state":"OK",
	"errorCode":"200",
	"errorMessage":"",
	"requestId":"145033850139465ca06206291d89cbd7"
}
本文档内容整理自移动云官方帮助中心(查看原文),仅供参考。