查询全量备份列表
功能介绍
查询全量备份列表。
调用方法
请参见如何调用API。
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 |
MysqlDatastoreInBackup 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=3ef58db3986540d19f95151309368d34in07&backup_id=7420f28010084e838113e78f77093093br07&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" : "7420f28010084e838113e78f77093093br07", "name" : "GaussDBforMySQL-gauss-e747-20200708185048266", "begin_time" : "2020-07-08T20:43:14+0800", "end_time" : "2020-07-08T20:45:14+0800", "take_up_time" : 2, "status" : "COMPLETED", "type" : "auto", "size" : 2803, "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0" }, "instance_id" : "3ef58db3986540d19f95151309368d34in07", "instance_name" : "GaussDBforMySQL-gauss-e747", "backup_level" : "2" } ], "total_count" : 1 }
SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.gaussdb.v3.region.GaussDBRegion; import com.huaweicloud.sdk.gaussdb.v3.*; import com.huaweicloud.sdk.gaussdb.v3.model.*; public class ShowGaussMySqlBackupListSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); GaussDBClient client = GaussDBClient.newBuilder() .withCredential(auth) .withRegion(GaussDBRegion.valueOf("<YOUR REGION>")) .build(); ShowGaussMySqlBackupListRequest request = new ShowGaussMySqlBackupListRequest(); try { ShowGaussMySqlBackupListResponse response = client.showGaussMySqlBackupList(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkgaussdb.v3.region.gaussdb_region import GaussDBRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkgaussdb.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = GaussDBClient.new_builder() \ .with_credentials(credentials) \ .with_region(GaussDBRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowGaussMySqlBackupListRequest() response = client.show_gauss_my_sql_backup_list(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" gaussdb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := gaussdb.NewGaussDBClient( gaussdb.GaussDBClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowGaussMySqlBackupListRequest{} response, err := client.ShowGaussMySqlBackupList(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
Success. |
400 |
Client error. |
500 |
Server error. |
错误码
请参见错误码。