接口功能介绍

查询云主机备份详情

准备工作

构造请求：在调用前需要了解如何构造请求，详情查看构造请求

认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权

接口约束

使用限制，本接口只支持在拉萨3、上海7、广州6、郴州2、长沙3、北京5、内蒙6、南京3、重庆2、合肥2、成都4、晋中、昆明2、乌鲁木齐27、福州25、衡阳3、长沙37、张家界2、华北2、央企北京1、华东1、上海32、上海33、上海36资源池进行公测
云主机备份必须存在

URI

GET /v4/ecs/backup/details

路径参数

无

Query参数

参数	是否必填	参数类型	说明	示例	下级对象
regionID	是	String	资源池ID，您可以查看地域和可用区来了解资源池获取：`查`资源池列表查询	bb9fdb42056f11eda1610242ac110002
instanceBackupID	是	String	云主机备份ID，您可以查看产品定义-云主机备份来了解云主机备份获取：`查`查询云主机备份列表 `创` 创建云主机备份	82ef7698-76a3-ede8-0c6d-c94a4acd73b0

请求参数

请求头 header 参数

无

请求体body参数

无

响应参数

参数	参数类型	说明	示例	下级对象
statusCode	Integer	返回状态码（800为成功，900为失败）	800
errorCode	String	业务细分码，为product.module.code三段式码，详见错误码说明	Openapi.PatternCheck.NotValid
message	String	失败时的错误描述，一般为英文描述	SUCCESS
description	String	失败时的错误描述，一般为中文描述	成功
returnObj	Object	返回参数		returnObj

表 returnObj

参数	参数类型	说明	示例
instanceBackupID	String	云主机备份ID	82ef7698-76a3-ede8-0c6d-c94a4acd73b0
instanceBackupName	String	云主机备份名称	test-0012
instanceBackupStatus	String	备份状态，取值范围：CREATING: 备份创建中, ACTIVE: 可用， RESTORING: 备份恢复中，DELETING: 删除中，EXPIRED：到期，ERROR：错误	ACTIVE
instanceBackupDescription	String	云主机备份描述	test
instanceID	String	云主机ID	cb51e0db-8e20-7434-4208-2a6fef86588f
instanceName	String	云主机名称	test
repositoryID	String	云主机备份存储库ID	c86251a9-1527-4b4e-82c7-f468ed8b8b2d
repositoryName	String	云主机备份存储库名称	repo-ea61
repositoryExpired	Boolean	云主机备份存储库是否过期	false
repositoryFreeze	Boolean	存储库是否冻结	false
diskTotalSize	Integer	云硬盘总容量大小	45
usedSize	Integer	磁盘备份已使用大小	0
diskCount	Integer	云硬盘数目	2
restoreFinishedTime	String	备份恢复完成时间	null
createdTime	String	创建时间	2023-03-13T05:56:33Z
finishedTime	String	完成时间	2023-03-13T06:05:51Z
projectID	String	企业项目ID	0

请求示例

请求url

示例：查询云主机备份的详细信息
GET .../v4/ecs/backup/details?regionID=bb9fdb42056f11eda1610242ac110002&instanceBackupID=82ef7698-76a3-ede8-0c6d-c94a4acd73b0

请求头header

无

请求体body

无

响应示例

{
	"returnObj": {
		"finishedTime": "2023-03-13T06:05:51Z",
		"instanceBackupName": "test-0012",
		"repositoryFreeze": false,
		"instanceID": "cb51e0db-8e20-7434-4208-2a6fef86588f",
		"diskTotalSize": 45,
		"usedSize": 0,
		"diskCount": 2,
		"repositoryID": "c86251a9-1527-4b4e-82c7-f468ed8b8b2d",
		"instanceBackupID": "82ef7698-76a3-ede8-0c6d-c94a4acd73b0",
		"instanceBackupDescription": "test",
		"projectID": "0",
		"createdTime": "2023-03-13T05:56:33Z",
		"restoreFinishedTime": null,
		"repositoryExpired": false,
		"repositoryName": "repo-ea61",
		"instanceName": "test",
		"instanceBackupStatus": "ACTIVE"
	},
	"message": "SUCCESS",
	"description": "成功",
	"statusCode": 800
}

状态码

状态码	描述
200	表示请求成功。

错误码说明

errorCode	描述
Openapi.PatternCheck.NotValid	请求参数非法
EcsBackup.RegionInfo.Empty	查询资源池信息为空或资源池不存在，请确认资源池ID是否有效
Openapi.PatternCheck.NotValid	请求参数非法
Ecs.PatternCheck.SortNotValid	排序参数不合法
EcsBackup.Backup.NotFound	未找到云主机备份信息
EcsBackup.WorkOrder.QueryFail	查询云主机备份失败

云主机备份

查询备份详情