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

可选参数暂时不添加示例值
推荐使用 /v4/ebs-backup/list-backups 接口

请求参数

Query 参数

regionID

string

资源池id

必需

示例值:

TestRegionID

volumeID

string

云硬盘ID

可选

volumeName

string

可选

云硬盘名称，精确查找

backupName

string

可选

云硬盘备份名称，精确查找

repositoryID

string

可选

精确查找，根据存储库uuid进行筛选

status

string

可选

根据备份状态进行筛选，creating-创建中, available-可用, deleting-删除中，error-异常, restoring-恢复中, error_deleting-删除异常

queryContent

string

可选

模糊查找，根据备份uuid或名字进行筛选

backupID

string

可选

云硬盘备份ID，精确查找

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200successful operation

application/json

Body

description

string

描述

可选

errorCode

string

错误码

可选

message

string

错误说明

可选

returnObj

array [object {37}]

响应对象

可选

regionID

string

资源池ID

可选

backupID

string

云硬盘备份ID

可选

backupName

string

云硬盘备份名称

可选

status

string

可选

云硬盘备份状态。creating:创建中, available:可用, deleting:删除中，error:异常, restoring:恢复中, error_deleting: 删除异常

size

integer <int32>

可选

云硬盘大小，单位GB

usedSize

integer <int64>

Long

可选

云硬盘备份大小，单位Byte

description

string

云硬盘备份描述

可选

repositoryID

string

备份库ID

可选

repositoryName

string

备份库名称

可选

createdDate

integer <int32>

创建时间

可选

updatedDate

integer <int32>

更新时间

可选

expiredDate

integer <int32>

到期时间

可选

finishDate

integer <int32>

备份完成时间

可选

restoreDate

integer <int32>

可选

使用该云硬盘备份恢复数据时间

restoreFinishDate

integer <int32>

可选

使用该云硬盘备份恢复完成时间

freeze

boolean

是否冻结

可选

volumeID

string

云硬盘ID

可选

volumeName

string

云硬盘名称

可选

encrypted

string

云硬盘是否加密

可选

cmkUUID

string

可选

云硬盘加密密钥UUID

volumeType

string

云硬盘类型

可选

azName

string

可用域

可选

pass

string

是否支持PASS

可选

vMID

string

挂载的云主机ID

可选

vMName

string

挂载的云主机名称

可选

userId

integer <int32>

用户id

可选

ctUserPlatformsId

string

可选

用户在该资源池所对应的租户id

deleted

string

是否已删除

可选

zoneId

string

可用区id

可选

responseReceived

string

是否接收到应答

可选

resourceId

string

资源id

可选

uuid

string

云硬盘备份uuid

可选

volumeUuid

string

可选

创建备份的云硬盘uuid

isIncremental

string

是否增量备份

可选

parentId

string

可选

增量备份的依赖备份uuid

volumeStatus

string

可选

volumeStatus

instances

array [object {3}]

可选

创建该备份的云硬盘所挂载的所有云主机相关信息

statusCode

integer <int32>

请求状态码

可选

示例

{
    "description": "成功",
    "errorCode": "SUCCESS",
    "message": "success",
    "returnObj": [
        {
            "azName": "中国|天翼云资源池|指定区域``",
            "backupID": "10fd96c6-a305-4536-be56-2321272cf07f",
            "backupName": "volume-zhr-497_auto-backup_48fda55",
            "createdDate": 1676600030,
            "description": "",
            "freeze": false,
            "pass": false,
            "regionID": "TestRegionID",
            "repositoryID": "912b1029-aeea-529c-aa90-0afd8ded20eb",
            "repositoryName": "storage-xvmk",
            "size": 1,
            "status": "available",
            "updatedDate": 1680821041,
            "usedSize": 24470,
            "vMID": "",
            "vMName": "",
            "volumeID": "4584339d-f786-49d5-abca-e797fd462cae",
            "volumeName": "volume-zhr-497",
            "volumeType": "SATA-public"
        },
        {
            "azName": "中国|天翼云资源池|指定区域``",
            "backupID": "159d5ece-afb3-45aa-b56f-5739b4db1aff",
            "backupName": "backup-ufcvj",
            "createdDate": 1676570793,
            "description": "",
            "freeze": false,
            "pass": false,
            "regionID": "TestRegionID",
            "repositoryID": "639d4b18-467c-52a0-bf10-41a185598f23",
            "repositoryName": "hjftest-测试勿删",
            "size": 1,
            "status": "available",
            "updatedDate": 1680821041,
            "usedSize": 24470,
            "vMID": "4fdba5da-3747-ffec-6641-d4e29ad693cd",
            "vMName": "LddTest-584",
            "volumeID": "0207fe61-7529-4993-9357-51b60d1f6904",
            "volumeName": "volume-zhr-446",
            "volumeType": "SATA-public"
        }
    ],
    "statusCode": 800
}