接口说明
面向政企版租户开放获取云电脑列表信息接口 限流:根据租户实现用户级别的限流,限制为10次每秒 提示:SDK调用时Client配置地域信息请填写中心资源池编码CIDC-CORE-00,详情请参考官网SDK代码示例
URL
POST https://ecloud.10086.cn/api/Computer_api/cem_openapi/ccacem/api/v1/machine/getList
请求参数
Body
|
参数名称
|
类型
|
必填
|
描述
|
|
request
|
分页请求实体
|
是
|
查询云电脑列表请求入参 |
|
instanceId
|
string
|
否
|
订购资源ID |
|
machineId
|
string
|
否
|
云电脑主机id |
|
machineName
|
string
|
否
|
云电脑名称 |
|
machineStatus
|
string
|
否
|
运行状态(available可用、shutdown关机、onShutdown关机中、onAvailable开机中、onReload重装系统中、onRestart重启中、exception异常) |
|
page
|
integer(int32)
|
是
|
当前页 |
|
pageSize
|
integer(int32)
|
是
|
每页显示条数 |
|
policyId
|
string
|
否
|
策略ID |
|
policyName
|
string
|
否
|
策略名称 |
|
poolId
|
string
|
否
|
资源池id |
|
resourceTypeName
|
string
|
否
|
规格名称 |
|
userName
|
string
|
否
|
登录账号 |
请求示例
POST https://ecloud.10086.cn/api/Computer_api/cem_openapi/ccacem/api/v1/machine/getList
{
"instanceId":"CCA-bda25b8a2306425aa14f38b8f43a94b2",
"machineId":"c9463d9a-1p19-4153-abd7-3532095770g3",
"machineName":"我的电脑",
"machineStatus":"available",
"page":"1",
"pageSize":"10",
"policyId":"",
"policyName":"",
"poolId":"CIDC-RP-25",
"resourceTypeName":"通用办公型-规格1",
"userName":"test.x4091d"
}
返回参数
|
参数名称
|
类型
|
描述
|
|
body
|
分页返回实体«资源列表返回实体»
|
请求成功时返回的数据 |
|
data
|
<资源列表返回实体> array
|
数据 |
|
bandwidthMax
|
integer(int32)
|
所在子网的带宽大小 |
|
computerProtocol
|
string
|
电脑协议(V2:自研CMSSZTE,V1.1:新华三,V1.2:中兴,V 1.4:中兴大云融合) |
|
createdTime
|
string
|
创建时间 |
|
dc
|
string
|
数据中心/网络工作区 |
|
effectiveTime
|
string
|
生效时间 |
|
extDataDiskSize
|
integer(int32)
|
数据盘大小 |
|
instanceId
|
string
|
订购资源ID |
|
intranetIP
|
string
|
内网IP |
|
machineId
|
string
|
云电脑主机id |
|
machineName
|
string
|
云电脑名称 |
|
machineStatus
|
string
|
运行状态(available可用、shutdown关机、onShutdown关机中、onAvailable开机中、onReload重装系统中、onRestart重启中、exception异常、imageCreating镜像制作中) |
|
mopUserId
|
string
|
mop用户id |
|
mopUserName
|
string
|
mop用户名 |
|
orderSourceCode
|
string
|
订购渠道 |
|
organizationName
|
string
|
所属组织 |
|
policyId
|
string
|
策略ID |
|
policyName
|
string
|
策略名称 |
|
poolCode
|
string
|
资源池编码 |
|
poolId
|
string
|
资源池id |
|
poolName
|
string
|
资源池名称 |
|
region
|
string
|
可用区 |
|
resourceTypeCode
|
string
|
规格code |
|
resourceTypeName
|
string
|
规格名称 |
|
sysDiskSize
|
string
|
系统盘 |
|
tenantId
|
string
|
租户表主键id |
|
uname
|
string
|
用户名 |
|
userName
|
string
|
登录账号 |
|
vpcName
|
string
|
VPC |
|
totalSize
|
integer(int32)
|
总行数 |
|
errorCode
|
string
|
统一错误码 |
|
errorMessage
|
string
|
错误提示信息 |
|
requestId
|
string
|
每个请求的序列号 |
|
state
|
enum(OK,ERROR,EXCEPTION,FORBIDDEN,REMAINING,TIMEOUT)
|
返回状态码;返回正常:OK,返回错误:ERROR,返回异常:EXCEPTION,需要告警实现的:ALARM,禁止访问:FORBIDDEN |
返回示例
{
"body":{
"data":[
{
"bandwidthMax":"",
"computerProtocol":"",
"createdTime":"",
"dc":"ONEDAAS-SERVICE-0002",
"effectiveTime":"",
"extDataDiskSize":"1",
"instanceId":"CCA-bda25b8a2306425aa14f38b8f43a94b2",
"intranetIP":"",
"machineId":"c9463d9a-1p19-4153-abd7-3532095770g3",
"machineName":"我的电脑",
"machineStatus":"available",
"mopUserId":"",
"mopUserName":"",
"orderSourceCode":"1 官网订购, 0 云管分配",
"organizationName":"",
"policyId":"",
"policyName":"",
"poolCode":"CIDC-RP-26",
"poolId":"CIDC-RP-25",
"poolName":"华东-上海1",
"region":"CIDC-RP-26-AZ1",
"resourceTypeCode":"Enterprise_2C4G_01",
"resourceTypeName":"通用办公型-规格1",
"sysDiskSize":"80",
"tenantId":"",
"uname":"",
"userName":"abc.com",
"vpcName":""
}
],
"totalSize":"100"
},
"errorCode":"",
"errorMessage":"",
"requestId":"",
"state":""
}