查询云主机备份状态
接口功能介绍
查询云主机备份状态
接口约束
- 使用限制,本接口只支持在拉萨3、上海7、广州6、郴州2、长沙3、北京5、内蒙6、南京3、重庆2、合肥2、成都4、晋中、昆明2、乌鲁木齐27、福州25、衡阳3、长沙37、张家界2、华北2、央企北京1、华东1、上海32、上海33、上海36资源池进行公测
- 当前页面接口为旧版 API,未来根据实际使用情况可能退役,推荐使用新版本接口,新版本接口更加规范,覆盖场景更全。
URI
POST /v4/ecs/backup-status
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以调用regionID查看最新的天翼云资源池列表 | b6bb383e876c11ea8a5e0242ac110002 | |
instanceBackupID | 是 | String | 云主机备份ID | ed48dc25-d6bb-48e6-b202-3e36ee6321a3 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | String | 业务细分码,为product.module.code三段式码,详见错误码说明 | ||
message | String | 失败时的错误描述,一般为英文描述 | ||
description | String | 失败时的错误描述,一般为中文描述 | ||
returnObj | Object | 返回参数 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
status | String | 备份状态,取值范围:CREATING: 备份创建中, ACTIVE: 可用, RESTORING: 备份恢复中,DELETING: 删除中,EXPIRED:到期,ERROR:错误 |
请求示例
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"instanceBackupID": "b6e2966d-7b1c-385e-abe4-d940caa273b7"
}
响应示例
{
"returnObj": {
"status": "ACTIVE"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
errorCode | 描述 |
---|---|
Ecs.Parameter.InvalidNotValid | 请求参数非法 |
EcsBackup.RegionInfo.Empty | 查询资源池信息为空或资源池不存在,请确认资源池ID是否有效 |
Openapi.EcsBackupWorkorder.AccessFailed | 获取备份失败 |
Openapi.EcsBackupParameter.NotValid | 请求参数非法 |
Ecs.Backup.NotFound | 找不到备份 |