接口说明
开放政企版查询快照列表接口 支持通过快照名称/快照UID/云电脑ID/云电脑名称、快照状态查询快照列表,包括快照名称、快照ID、云电脑名称、云电脑ID、磁盘类型、状态、描述、创建时间。 限流:根据租户实现用户级别的限流,限制为10次每秒
URL
POST https://ecloud.10086.cn/api/Computer_api/cem_openapi/ccacem/api/v1/snapshot/listSnapshot
请求参数
Body
|
参数名称
|
类型
|
必填
|
描述
|
|
reqDto
|
SnapshotListOpenapiReqDto
|
是
|
请求入参 |
|
snapshotId
|
string
|
否
|
快照UID |
|
snapshotName
|
string
|
否
|
快照名称 |
|
snapshotStatus
|
string
|
否
|
快照状态,creating:创建中,create:创建完成,createError:创建失败,deleting:删除中,deleted:已删除,deletedError:删除失败 |
|
machineId
|
string
|
否
|
云电脑ID |
|
machineName
|
string
|
否
|
云电脑名称 |
|
currentPage
|
integer(int32)
|
否
|
当前页 |
|
pageSize
|
integer(int32)
|
否
|
分页大小 |
请求示例
POST https://ecloud.10086.cn/api/Computer_api/cem_openapi/ccacem/api/v1/snapshot/listSnapshot
{
"snapshotId":"1af97c5f-45e7-4e0f-9efe-78c2d6408ad0",
"snapshotName":"snapshot-111",
"snapshotStatus":"create",
"machineId":"462114f8-6aa8-4e2d-b6dc-46eeadbf3533",
"machineName":"我的电脑",
"currentPage":1,
"pageSize":10
}
返回参数
返回码:200
OK
|
参数名称
|
类型
|
描述
|
|
body
|
PageReturnEntity«TenantListSnapshotRespDto»
|
请求成功时返回的数据 |
|
data
|
<TenantListSnapshotRespDto> array
|
数据 |
|
createdTime
|
string
|
创建时间 |
|
machineId
|
string
|
云电脑ID |
|
machineName
|
string
|
云电脑名称 |
|
responseMsg
|
string
|
底层最近一次交互返回的信息 |
|
snapshotId
|
string
|
快照UID |
|
snapshotName
|
string
|
快照名称 |
|
snapshotRemark
|
string
|
快照描述 |
|
snapshotStatus
|
string
|
快照状态,creating:创建中,create:创建完成,createError:创建失败,deleting:删除中,deleted:已删除,deletedError:删除失败 |
|
snapshotTarget
|
string
|
快照范围,系统及数据盘(all)、仅系统盘(system)、仅数据盘(data) |
|
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":[
{
"snapshotId":"1af97c5f-45e7-4e0f-9efe-78c2d6408ad0",
"snapshotName":"snapshot-111",
"snapshotRemark":"",
"machineId":"58b8d5c7-79ea-4bbf-aece-8ab7f4370a27",
"machineName":"我的电脑",
"snapshotStatus":"create",
"snapshotTarget":"system",
"responseMsg":null,
"createdTime":"2024-08-08 10:42:30"
}
],
"totalCount":1
},
"errorCode":"200",
"errorMessage":"",
"requestId":"bef1e6cb620c48239dcbe40f849be166"
}