更新时间:2024-02-04 GMT+08:00
分享

查询全量备份列表

功能介绍

查询全量备份列表。

调用方法

请参见如何调用API

URI

GET /v3/{project_id}/backups

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的project ID。

获取方法请参见获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

instance_id

String

实例ID,严格匹配UUID规则。

backup_id

String

备份ID。

backup_type

String

备份类型。

取值范围:

  • auto:自动全量备份。

  • manual:手动全量备份。

offset

String

索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。

limit

String

查询记录数。默认为100,不能为负数,最小值为1,最大值为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

备份名称。

instance_name

String

实例名称。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

String

请求语言类型。默认en-us。 取值范围:

  • en-us

  • zh-cn

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

backups

Array of backups objects

备份信息。

total_count

Long

备份文件的总数。

表5 backups

参数

参数类型

描述

id

String

备份ID。

name

String

备份名称。

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

备份状态,取值:

  • BUILDING:备份中。

  • COMPLETED:备份完成。

  • FAILED:备份失败。

  • AVAILABLE:备份可用。

枚举值:

  • BUILDING

  • COMPLETED

  • FAILED

  • AVAILABLE

take_up_time

Integer

备份花费时间(单位:minutes)。

type

String

备份类型,取值:

  • auto:自动全量备份。

  • manual:手动全量备份。

枚举值:

  • auto

  • manual

size

Long

备份大小(单位:MB)。

datastore

MysqlDatastoreInBackup object

数据库信息。

instance_id

String

实例ID,严格匹配UUID规则。

instance_name

String

实例名称。

backup_level

String

备份级别。当开启一级备份开关时,返回该参数。

取值:

  • 0:备份正在创建中或者备份失败。

  • 1:一级备份。

  • 2:二级备份。

枚举值:

  • 0

  • 1

  • 2

description

String

备份文件描述信息。

表6 MysqlDatastoreInBackup

参数

参数类型

描述

type

String

数据库引擎,现在只支持gaussdb-mysql。

version

String

数据库版本。

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码: 500

表8 响应Body参数

参数

参数类型

描述

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-08T18:41: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
48
49
50
51
52
53
54
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");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        GaussDBClient client = GaussDBClient.newBuilder()
                .withCredential(auth)
                .withRegion(GaussDBRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowGaussMySqlBackupListRequest request = new ShowGaussMySqlBackupListRequest();
        request.withInstanceId("<instance_id>");
        request.withBackupId("<backup_id>");
        request.withBackupType("<backup_type>");
        request.withOffset("<offset>");
        request.withLimit("<limit>");
        request.withBeginTime("<begin_time>");
        request.withEndTime("<end_time>");
        request.withName("<name>");
        request.withInstanceName("<instance_name>");
        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
32
33
34
35
36
37
38
# coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = GaussDBClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(GaussDBRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowGaussMySqlBackupListRequest()
        request.instance_id = "<instance_id>"
        request.backup_id = "<backup_id>"
        request.backup_type = "<backup_type>"
        request.offset = "<offset>"
        request.limit = "<limit>"
        request.begin_time = "<begin_time>"
        request.end_time = "<end_time>"
        request.name = "<name>"
        request.instance_name = "<instance_name>"
        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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := gaussdb.NewGaussDBClient(
        gaussdb.GaussDBClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowGaussMySqlBackupListRequest{}
	instanceIdRequest:= "<instance_id>"
	request.InstanceId = &instanceIdRequest
	backupIdRequest:= "<backup_id>"
	request.BackupId = &backupIdRequest
	backupTypeRequest:= "<backup_type>"
	request.BackupType = &backupTypeRequest
	offsetRequest:= "<offset>"
	request.Offset = &offsetRequest
	limitRequest:= "<limit>"
	request.Limit = &limitRequest
	beginTimeRequest:= "<begin_time>"
	request.BeginTime = &beginTimeRequest
	endTimeRequest:= "<end_time>"
	request.EndTime = &endTimeRequest
	nameRequest:= "<name>"
	request.Name = &nameRequest
	instanceNameRequest:= "<instance_name>"
	request.InstanceName = &instanceNameRequest
	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.

错误码

请参见错误码

分享:

    相关文档

    相关产品