查询实例备份信息
功能介绍
查询指定缓存实例的备份信息列表。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/instances/{instance_id}/backups
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
instance_id |
是 |
String |
实例ID。 |
project_id |
是 |
String |
项目ID。获取方法请参见获取项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
begin_time |
否 |
String |
查询开始时间,时间为UTC时间。格式:yyyyMMddHHmmss,如:20170718235959。 |
end_time |
否 |
String |
查询结束时间,时间为UTC时间。格式:yyyyMMddHHmmss,如:20170718235959。 |
limit |
否 |
Integer |
每页显示的条目数量。 |
offset |
否 |
Integer |
偏移量,表示从此偏移量开始查询, offset大于等于0。 |
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
total_num |
Integer |
返回记录数。 |
backup_record_response |
Array of BackupRecordResponse objects |
备份信息的详情数组。 |
参数 |
参数类型 |
描述 |
---|---|---|
backup_id |
String |
备份记录ID。 |
period |
String |
备份执行时间段。 |
backup_name |
String |
备份记录名称。 |
instance_id |
String |
实例ID。 |
size |
Long |
备份文件大小(Byte)。 |
backup_type |
String |
备份类型。
|
created_at |
String |
备份任务创建时间。 |
updated_at |
String |
备份完成时间。 |
progress |
String |
备份进度。 |
error_code |
String |
备份失败后错误码
|
remark |
String |
备份缓存实例的备注信息。 |
status |
String |
备份状态。
|
is_support_restore |
String |
是否可以进行恢复操作,取值为TRUE或FALSE。 |
execution_at |
String |
执行时间。 |
backup_format |
String |
备份类型。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误信息。 |
error_code |
String |
错误码。 |
error_ext_msg |
String |
扩展错误信息(暂未使用,赋值为null)。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误信息。 |
error_code |
String |
错误码。 |
error_ext_msg |
String |
扩展错误信息(暂未使用,赋值为null)。 |
请求示例
GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/backups?offset={offset}&limit={limit}&beginTime={begin_Time}&end_time={end_Time}
响应示例
状态码: 200
查询缓存实例备份信息成功。
{ "total_num" : 1, "backup_record_response" : [ { "period" : { }, "backup_type" : "manual", "created_at" : "2019-05-10T08:31:16.166Z", "remark" : "001", "is_support_restore" : "TRUE", "backup_id" : "4631832a-14c6-45b0-a0b3-3abd8f591ad1", "backup_name" : "backup_20190510163116", "instance_id" : "5560df16-cebf-4473-95c4-d1b573c16e79", "size" : 880232, "updated_at" : "2019-05-10T08:32:30.546Z", "progress" : "100.00", "error_code" : { }, "status" : "succeed", "execution_at" : "2019-05-11T08:31:16.166Z", "backup_format" : "aof" } ] }
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 |
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.dcs.v2.region.DcsRegion; import com.huaweicloud.sdk.dcs.v2.*; import com.huaweicloud.sdk.dcs.v2.model.*; public class ListBackupRecordsSolution { 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); DcsClient client = DcsClient.newBuilder() .withCredential(auth) .withRegion(DcsRegion.valueOf("<YOUR REGION>")) .build(); ListBackupRecordsRequest request = new ListBackupRecordsRequest(); request.withInstanceId("{instance_id}"); try { ListBackupRecordsResponse response = client.listBackupRecords(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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdcs.v2.region.dcs_region import DcsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdcs.v2 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 = DcsClient.new_builder() \ .with_credentials(credentials) \ .with_region(DcsRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListBackupRecordsRequest() request.instance_id = "{instance_id}" response = client.list_backup_records(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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dcs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/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 := dcs.NewDcsClient( dcs.DcsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListBackupRecordsRequest{} request.InstanceId = "{instance_id}" response, err := client.ListBackupRecords(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
查询缓存实例备份信息成功。 |
204 |
查询缓存实例备份当前无记录。 |
400 |
非法请求。 |
500 |
内部服务错误。 |
错误码
请参见错误码。