全部文档
当前文档

暂无内容

如果没有找到您期望的内容,请尝试其他搜索词

文档中心

备份-备份列表

接口说明

查询指定实例备份列表。

注意:支持分页,默认展示前10条。

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数
参数名称
类型
必填
描述
Action String
公共参数,本接口取值:ListBackup。
Version String
公共参数,本接口取值:2023-10-10。
InstanceId String

实例id

BackupName String

备份名称(模糊查询)

Offset Int

开始页码

注意:第一页默认页码0
示例值:0
默认值:0
Limit Int

每页展示条数

注意:默认每页展示10
示例值:10
默认值:10

返回参数

参数名称
类型
描述
RequestId String
示例值:7b046ef2-9434-4d09-a353-8f8f5bc12a97
Code String
示例值:0
Message String
示例值:success
Offset Int
示例值:0
Limit Int
示例值:10
Total Int
示例值:1
Data Object[]

备份列表数据

BackupId String

备份id

示例值:e9d06c16-51f3-47cd-b849-0d2c3435c9e1
BackupName String

备份名称

示例值:bakcup-2
BackupState String

备份状态

COMPLETED: '正常',
BUILDING: '创建中',
NEW: '初始化',
FAILED: '异常'
示例值:COMPLETED
BackupMethod String

备份类型(手动/自动)

示例值:manual
BackupDimension String

备份描述

示例值:databases
BackupSize Int

备份大小(前端展示会转为MB)

示例值:577222
RetentionDays Int

备份保留天数

示例值:0
Collections Object[]

备份维度详细信息

DbName String

db名称

示例值:db22
CollectionName String

collection名称

示例值:tb222
LoadState String

加载阶段

Loaded: '已加载',
NotLoad: '未加载',
Loading: '加载中'
示例值:Loaded
Size Int

大小(前端展示转为MB)

示例值:55540
Description String

描述

示例值:nihao
CreatedAt String

创建时间

示例值:2024-12-26T17:02:52.745652

请求示例

curl -X GET
'http://milvus.api.ksyun.com/?Action=ListBackup&Version=2023-10-10&InstanceId=xxx&BackupName=xxx&Offset=0&Limit=10'
-H 'authorization: xxx, SignedHeaders=content-type;host;x-amz-date, Signature=xxx'
-H 'cache-control: no-cache'
-H 'content-type: application/json'
-H 'host: milvus.api.ksyun.com'
-H 'x-amz-date: 20170720T022802Z'

返回示例

JSON格式

{
"RequestId":"7b046ef2-9434-4d09-a353-8f8f5bc12a97",
"Code":"0",
"Message":"success",
"Offset":0,
"Limit":10,
"Total":1,
"Data":[
{
"BackupId":"e9d06c16-51f3-47cd-b849-0d2c3435c9e1",
"BackupName":"bakcup-2",
"BackupState":"COMPLETED",
"BackupMethod":"manual",
"BackupDimension":"databases",
"BackupSize":577222,
"RetentionDays":0,
"Collections":[
{
"DbName":"db22",
"CollectionName":"tb222",
"LoadState":"Loaded",
"Size":55540,
"Description":"nihao"
},
{
"DbName":"default",
"CollectionName":"tablet",
"LoadState":"Loaded",
"Size":521682,
"Description":"我是一张表"
}
],
"CreatedAt":"2024-12-26T17:02:52.745652"
}
]
}

错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码
错误信息
Http状态码
描述
InvalidParameter参数错误400参数错误
LIST_BACKUPS_ERROR查询异常400查询异常
INVALID_REQUEST_NOT_FOUND无效参数400无效参数
纯净模式常规模式

纯净模式

点击可全屏预览文档内容