查询全量备份列表
URI
GET /v3/{project_id}/backups
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
instance_id |
否 |
String |
参数解释: 实例ID,此参数是实例的唯一标识。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,后缀为in07,长度为36个字符。 默认取值: 不涉及。 |
backup_id |
否 |
String |
参数解释: 备份ID,此参数是备份的唯一标识。。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,后缀为br07,长度为36个字符。 默认取值: 不涉及。 |
backup_type |
否 |
String |
参数解释: 备份类型。 约束限制: 不涉及。 取值范围:
默认值: 不涉及。 |
offset |
否 |
String |
参数解释: 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询。 约束限制: 必须为整数,不能为负数。 取值范围: ≥0 默认取值: 0 |
limit |
否 |
String |
参数解释: 查询记录数。 约束限制: 必须为整数,不能为负数。 取值范围: 1-100 默认取值: 100 |
begin_time |
否 |
String |
参数解释: 查询开始时间,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 约束限制: 不涉及。 取值范围: 比当前时间早。 默认取值: 不涉及。 |
end_time |
否 |
String |
参数解释: 查询结束时间,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 约束限制: 不涉及。 取值范围: 比当前时间早,比开始时间晚。 默认取值: 不涉及。 |
name |
否 |
String |
参数解释: 备份名称。 约束限制: 不涉及。 取值范围: 备份名称长度最小为4个字符,最大为64个字符且不超过64个字节(注意:一个中文字符占用3个字节),必须以字母或中文开头,区分大小写,可以包含字母、数字、中文、中划线或下划线,不能包含其他特殊字符。 默认取值: 不涉及。 |
instance_name |
否 |
String |
参数解释: 实例名称。 约束限制: 不涉及。 取值范围: 最小为4个字符,最大为64个字符且不超过64个字节(注意:一个中文字符占用3个字节),必须以字母或中文开头,区分大小写,可以包含字母、数字、中划线、下划线或中文,不能包含其他特殊字符。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认值: 不涉及。 |
X-Language |
否 |
String |
参数解释: 请求语言类型。 约束限制: 不涉及。 取值范围:
默认值: en-us。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
backups |
Array of backups objects |
参数解释: 备份信息。 取值范围: 不涉及。 |
total_count |
Long |
参数解释: 备份文件的总数。 取值范围: ≥0 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 备份ID。 取值范围: 只能由英文字母、数字组成,后缀为br07,长度为36个字符。 |
name |
String |
参数解释: 备份名称。 取值范围: 备份名称长度最小为4个字符,最大为64个字符且不超过64个字节(注意:一个中文字符占用3个字节),必须以字母或中文开头,区分大小写,可以包含字母、数字、中文、中划线或下划线,不能包含其他特殊字符。 |
begin_time |
String |
参数解释: 备份开始时间,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 取值范围: 不涉及。 |
end_time |
String |
参数解释: 备份结束时间,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 取值范围: 不涉及。 |
status |
String |
参数解释: 备份状态。 取值范围:
|
take_up_time |
Integer |
参数解释: 备份花费时间(单位:minutes)。 取值范围: ≥0。 |
type |
String |
参数解释: 备份类型。 取值范围:
|
size |
Long |
参数解释: 备份大小(单位:MB)。 取值范围: ≥0 |
datastore |
MysqlDatastore object |
参数解释: 数据库信息。 |
instance_id |
String |
参数解释: 实例ID,此参数是实例的唯一标识。 取值范围: 只能由英文字母、数字组成,后缀为in07,长度为36个字符。 |
instance_name |
String |
参数解释: 实例名称。 取值范围: 最小为4个字符,最大为64个字符且不超过64个字节(注意:一个中文字符占用3个字节),必须以字母或中文开头,区分大小写,可以包含字母、数字、中划线、下划线或中文,不能包含其他特殊字符。 |
backup_level |
String |
参数解释: 备份级别。当开启一级备份开关时,返回该参数。 取值范围:
|
description |
String |
参数解释: 备份文件描述信息。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
type |
String |
参数解释: 数据库引擎。 取值范围: gaussdb-mysql。 |
version |
String |
参数解释: 数据库版本。 取值范围: 8.0。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息。 |
请求示例
查询时间段内(2020-07-06~2020-07-16)的自动备份列表。
GET https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/backups?instance_id=43e4feaab48f11e89039fa163ebaa7e4br01&backup_id=c0c9f155c7b7423a9d30f0175998b63bbr01&backup_type=auto&offset=0&limit=10&begin_time=2020-07-06T10:41:14+0800&end_time=2020-07-16T10:41:14+0800
响应示例
状态码: 200
Success.
{ "backups" : [ { "id" : "1fe4feaab48f11e6654hfa163eba87e4b66u", "name" : "GaussDBforMySQL-gauss-e747-20200705185048266", "begin_time" : "2018-08-06T12:41:14+0800", "end_time" : "2018-08-06T12:45:14+0800", "take_up_time" : 2, "status" : "COMPLETED", "type" : "auto", "size" : 2803, "datastore" : { "type" : "GaussDB(for MySQL)", "version" : "8.0" }, "instance_id" : "43e4feaab48f11e89039fa163ebaa7e4br01", "instance_name" : "GaussDBforMySQL-gauss-e747", "backup_level" : "2" } ], "total_count" : 1 }
状态码
请参见状态码。
错误码
请参见错误码。