接口功能介绍

查询文档数据库实例备份列表

接口约束

用户通过鉴权认证

URI

GET /DDS2/v2/openApi/describeBackups

路径参数 无

Query参数

参数	是否必填	参数类型	说明	示例
prodInstId	是	String	文档数据库对外的实例标识	60d420bffb394***
prodInstFlag	否	String	数据库的标签规定为“实例ID 实例名称	60d420bffb394*** test001
backupName	否	String	备份名称	bak001
startTime	否	String	备份查询开始时间	2022-10-10 00:00:00 时间格式为：yyyy-MM-dd HH:mm:ss
endTime	否	String	备份查询结束时间	2022-10-10 00:00:00 时间格式为：yyyy-MM-dd HH:mm:ss
pageNow	否	Integer	当前页，不传默认为1	1
pageSize	否	Integer	页大小，不传默认为10	10
backupType	否	String	备份类型	自动备份手动备份
isCrossDomain	否	String	查询跨域备份列表	传参1表示查询跨域备份列表
isSubscribe	否	String	查询已退订实例备份列表	传参1表示查询已退订实例备份列表
errorCode	否	Byte	查询备份结果	3表示成功，5表示失败
targetRegionId	否	String	跨域备份列表筛选目标资源池	"81f7728662dd11ec810800155d307d5b" ，传该参数时，isCrossDomain参数需要传参 1

请求参数

请求头header参数

参数	是否必填	参数类型	说明	示例	下级对象
project-id	否	String	项目id	0
regionId	是	String	资源池id	bb9fdb42056f11eda1610242ac110002

请求体body参数 无

响应参数

参数	参数类型	说明	示例	下级对象
statusCode	Integer	响应码取值范围：800为成功，900为失败	800
message	String	响应信息	查询MongoDB实例的备份列表成功
returnObj	Object	返回对象		returnObj
error	String	错误码。当接口失败时才返回具体错误编码，成功不返回或者为空。
表 returnObj

参数	参数类型	说明	示例	下级对象
lastPage	Integer	最后一页的页码	1
navigatepageNums	Object	可用于导航的页码数组
startRow	Integer	当前页的第一行的索引	1
hasNextPage	Boolean	指示是否有下一页数据可用	false
prePage	Integer	前一页的页码	0
nextPage	Integer	下一页的页码	0
endRow	Integer	当前页的最后一行的索引	1
pageSize	Integer	每页包含的数据条目数量	10
list	Array of Objects	查询结果主体		list
pageNum	Integer	当前页的页码	1
navigatePages	Integer	导航页数的数量	8
total	Integer	总数据条目数量	1
pages	Integer	总页数	1
firstPage	Integer	第一页的页码	1
size	Integer	当前页包含的数据条目数量	1
isLastPage	Boolean	指示当前页是否是最后一页	true
hasPreviousPage	Boolean	指示是否有前一页数据可用	false
isFirstPage	Boolean	指示当前页是否是第一页	true
表 list

参数	参数类型	说明	示例
backupType	String	备份类型：自动备份，手动备份	自动备份
startTime	String	备份开始时间	1715409206000
errorCode	Integer	结果:0代表没有开始，1代表参数不对，2代表执行过程中，3代表成功，4代表被停止，5代表执行失败	3
prodInstName	String	实例名称	dds-342-recovernewinstance
datalen	String	数据备份处理的数据量	373M
storageType	String	存储类型，对象存储或云硬盘存储	对象存储
prodInstId	String	实例id	***
endTime	String	备份结束时间	1715409216000
backupName	String	备份名称	autoBackup_20240511143326141
id	String	备份记录id
prodType	Byte	实例类型：0:单机，2:副本集(三节点)，4:副本集(五节点)，6:副本集(七节点)，10:分片集群	2
prodDbEngine	String	数据库版本	4.0
isDelete	Integer	标记该记录是否被删除，0表示未删除，1表示删除	0

枚举参数

无

请求示例

请求url

/v2/openApi/describeBackups?prodInstId=a290bde98727433c966ecd52b8e66b3f

请求头header

project-id=0
regionId=bb9fdb42056f11eda1610242ac110002

请求体body

无

响应示例

{
    "statusCode": 800,
    "message": "查询MongoDB实例的备份列表成功",
    "returnObj": {
        "lastPage": 0,
        "navigatepageNums": null,
        "startRow": 0,
        "hasNextPage": false,
        "prePage": 0,
        "nextPage": 0,
        "endRow": 0,
        "pageSize": 1,
        "list": [
            {
                "prodInstName": "dds-342-recovernewinstance",
                "errorCode": 3,
                "storageType": "对象存储",
                "prodInstId": "60d420bffb394***",
                "startTime": 1715409206000,
                "endTime": 1715409216000,
                "backupName": "autoBackup_20240511143326141",
                "dataLen": "373M",
                "backupType": "自动备份",
                "id":260,
                "prodType":2,
                "prodDbEngine":"4.0",
                "isDelete":0
            }
        ],
        "pageNum": 1,
        "navigatePages": 0,
        "total": 32,
        "pages": 0,
        "firstPage": 0,
        "size": 0,
        "isLastPage": false,
        "hasPreviousPage": false,
        "isFirstPage": false
    }
}

状态码

请参考状态码

错误码

请参考错误码

智算服务

应用商城

定价

合作伙伴

开发者

支持与服务

了解天翼云

文档数据库服务

文档数据库服务

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码

活动

智算服务

应用商城

定价

合作伙伴

开发者

支持与服务

了解天翼云

文档数据库服务

文档数据库服务

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码