查询云硬盘备份库列表 - 混合云OpenAPI4.0

推荐使用/v4/ebs-backup/repo/list-repos接口

请求参数

Query 参数

regionID

string

资源池id

必需

示例值:

TestRegionID

repositoryID

string

可选

云硬盘备份存储库ID

repositoryName

string

可选

云硬盘备份存储库名称

status

string

可选

云硬盘备份存储库状态:available-可用;unavailable-不可用

queryContent

string

可选

模糊查询，筛选存储库名称或uuid等于此参数值的存储库

hideExpire

string

可选

是否隐藏过期的云硬盘备份库

asc

string

可选

和sort配合使用，是否升序排列,Boolean 类 true/false

sort

string

可选

和asc配合使用，指定用于排序的字段。可选字段：createdDate/expiredDate/size/freeSize/usedSize/name(repositoryName)

resourceID

string

资源id

可选

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200successful operation

application/json

Body

returnObj

array [object {21}]

响应对象

可选

repositoryID

string

存储库id

可选

repositoryName

string

存储库名称

可选

regionID

string

资源池ID

可选

status

string

可选

云硬盘备份存储库状态:available-可用;unavailable-不可用

size

integer

可选

存储库大小，单位GB

freeSize

number <double>

可选

存储库剩余容量，单位GB, 类型为double

usedSize

integer <int64>

Long

可选

使用大小，单位byte

azName

string

可用区

可选

createdDate

integer <int64>

long

可选

创建时间

updatedDate

integer <int64>

long

可选

更新时间

expiredDate

integer <int64>

long

可选

过期时间

expired

boolean

是否已过期

可选

customerID

integer <int64>

用户id

可选

description

string

描述

可选

freeze

boolean

是否已冻结

可选

pass

boolean

是否为pass资源

可选

paymentType

string

计费方式

可选

ondemand：按需计费, package：包年包月
1.16.02及以上版本支持

cycleType

string

计费周期类型

可选

1- 按天/3- 按月/5- 按年
1.16.02及以上版本支持

resourceID

string

资源id

可选

backupList

array[string]

可选

备份库下的可用的备份列表，元素为备份ID

onDemand

boolean

可选

是否是按需资源 true:是；false：否 1.16.04版本新增字段

statusCode

integer <int32>

请求状态码

可选

description

string

描述

可选

errorCode

string

错误码

可选

message

string

错误说明

可选

示例

{
    "description": "成功 X-Trace-ID-->2b1d331aa49d6659",
    "errorCode": "SUCCESS",
    "message": "success",
    "returnObj": [
        {
            "azName": "",
            "backupList": [],
            "createdDate": 1710349911,
            "customerID": 1000001143,
            "cycleType": "3",
            "description": "",
            "expired": false,
            "expiredDate": 1715620311,
            "freeSize": 100,
            "freeze": false,
            "pass": false,
            "paymentType": "package",
            "onDemand": false,
            "repositoryID": "28de32af-d039-50a1-b014-613affe4b909",
            "repositoryName": "test-repo-001",
            "resourceID": "38cbc9aabedb4d0887a466321a206454",
            "size": 100,
            "status": "available",
            "updatedDate": 1710375799,
            "usedSize": 0
        }
    ],
    "statusCode": 800
}