接口功能介绍

根据过滤参数查询满足条件的云主机备份存储库，并返回云主机备份存储库列表

准备工作 ：

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

认证鉴权：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-repo/list

路径参数

无

Query参数

参数	是否必填	参数类型	说明	示例
regionID	是	String	资源池ID，您可以查看地域和可用区来了解资源池获取：`查` 资源池列表查询	bb9fdb42056f11eda1610242ac110002
projectID	否	String	企业项目ID，企业项目管理服务提供统一的云资源按企业项目管理，以及企业项目内的资源管理，成员管理。	0
repositoryName	否	String	云主机备份存储库名称，满足以下规则：只能由数字、字母、-组成，不能以数字和-开头、且不能以-结尾，长度为2-63字符	test-repo
repositoryID	否	String	云主机备份存储库ID，您可以查看产品定义-存储库来了解存储库获取：`查` 查询存储库列表 `创` 创建存储库	9915c3f4-8d78-445a-a1da-d8d9287d506b
status	否	String	存储库状态	active
pageNo	否	Integer	页码，取值范围：正整数（≥1），注：默认值为1	1
pageSize	否	Integer	每页记录数目，取值范围：[1~50]，默认值：10，单页最大记录不超过50	5

请求参数

请求头header参数

无

请求体body参数

无

响应参数

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

表 returnObj

参数	参数类型	说明	示例	下级对象
currentCount	Integer	当前页记录数目	1
totalCount	Integer	总记录数	10
totalPage	Integer	总页数	1
results	Array of Objects	分页明细		results

表 results

参数	参数类型	说明	示例
regionID	String	资源池ID	bb9fdb42056f11eda1610242ac110002
repositoryID	String	存储库ID	9915c3f4-8d78-445a-a1da-d8d9287d506b
projectID	String	企业项目ID	0
repositoryName	String	存储库名称	test-repo
status	String	云主机存储库状态，expired: 已到期，active: 可用	active
size	Integer	云主机存储库总容量，单位GB	100
freeSize	Integer	云主机存储库剩余大小，单位GB	90
usedSize	Integer	云主机存储库使用大小，单位Byte	10240000000
createdAt	String	创建时间	"2023-02-10T09:32:36Z"
expiredAt	String	到期时间	"2023-03-10T09:32:54Z"
expired	Boolean	存储库是否到期	false
freeze	Boolean	是否冻结	false
paas	Boolean	是否支持PAAS	false
backupList	Array of Strings	存储库下可用的备份ID列表	["59093d15-8a3c-53b9-b61b-484af10a3e97"]
backupCount	Integer	存储库中备份数量	2

请求示例

请求url

示例：查询华东1资源池的云主机存储库列表
GET '.../v4/ecs/backup-repo/list?regionID=bb9fdb42056f11eda1610242ac110002'

请求头header

无

请求体body

无

响应示例

{
    "returnObj": {
        "currentCount": 1,
        "totalCount": 17,
        "totalPage": 17,
        "results": [
            {
                "regionID": "bb9fdb42056f11eda1610242ac110002",
                "projectID": 0,
                "backupList": [],
                "paas": false,
                "freeze": false,
                "backupCount": 0,
                "repositoryID": "7d7a9c15-1460-4912-84a5-0ade4bc9a526",
                "repositoryName": "cbr-test-openapi",
                "status": "active",
                "size": 100,
                "freeSize": 100.0,
                "usedSize": 0,
                "createdAt": "2023-02-10T09:32:36Z",
                "expiredAt": "2023-03-10T09:32:54Z",
                "expired": false
            }
        ]
    },
    "message": "SUCCESS",
    "description": "成功",
    "statusCode": 800
}

状态码

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

错误码

errorCode	描述
EcsBackup.RegionInfo.Empty	查询资源池信息为空或资源池不存在，请确认资源池ID是否有效
EcsBackup.RegionInfo.AccessFailed	查询资源池失败
EcsBackup.RegionInfo.DataDamaged	资源池信息不符合预期
EcsBackup.RepositoryInfo.NotFound	云主机备份存储库未找到

云主机备份

查询云主机备份存储库列表