Listing DCS Instance Backup Records
Function
This API is used to query the backup records of a specific DCS instance.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/instances/{instance_id}/backups
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
instance_id |
Yes |
String |
Instance ID. |
project_id |
Yes |
String |
Project ID. For details, see Obtaining a Project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
begin_time |
No |
String |
Query start time (UTC). Format: yyyyMMddHHmmss, for example, 20170718235959. |
end_time |
No |
String |
Query end time (UTC). Format: yyyyMMddHHmmss, for example, 20170718235959. |
limit |
No |
Integer |
Number of items displayed on each page. |
offset |
No |
Integer |
Offset, which is the position where the query starts. The value must be greater than or equal to 0. |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total_num |
Integer |
Number of returned records. |
backup_record_response |
Array of BackupRecordResponse objects |
Array of the backup details. |
Parameter |
Type |
Description |
---|---|---|
backup_id |
String |
Backup ID. |
period |
String |
Backup execution time. |
backup_name |
String |
Backup record name. |
instance_id |
String |
Instance ID. |
size |
Long |
Size of the backup file (byte). |
backup_type |
String |
Backup type.
Enumeration values:
|
created_at |
String |
Time when the backup task is created. |
updated_at |
String |
Time at which DCS instance backup is completed. |
progress |
String |
Backup progress. |
error_code |
String |
Error code displayed for a backup failure.
|
remark |
String |
Description of DCS instance backup. |
status |
String |
Backup status. The options are as follows:
Enumeration values:
|
is_support_restore |
String |
Whether restoration is supported. Options: TRUE and FALSE. |
execution_at |
String |
Execution time. |
backup_format |
String |
Backup format. Enumeration values:
|
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Error message. Maximum: 1024 |
error_code |
String |
Error code. Maximum: 9 |
error_ext_msg |
String |
Extended error information. This parameter is not used currently and is set to null. Maximum: 1024 |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Error message. Maximum: 1024 |
error_code |
String |
Error code. Maximum: 9 |
error_ext_msg |
String |
Extended error information. This parameter is not used currently and is set to null. Maximum: 1024 |
Example Requests
GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/backups?offset={offset}&limit={limit}&beginTime={begin_Time}&end_time={end_Time}
Example Responses
Status code: 200
DCS instance backup records queried successfully.
{ "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 Sample Code
The SDK sample code is as follows.
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 |
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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); DcsClient client = DcsClient.newBuilder() .withCredential(auth) .withRegion(DcsRegion.valueOf("<YOUR REGION>")) .build(); ListBackupRecordsRequest request = new ListBackupRecordsRequest(); request.withBeginTime("<begin_time>"); request.withEndTime("<end_time>"); request.withLimit(<limit>); request.withOffset(<offset>); 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 33 |
# coding: utf-8 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 = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = DcsClient.new_builder() \ .with_credentials(credentials) \ .with_region(DcsRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListBackupRecordsRequest() request.begin_time = "<begin_time>" request.end_time = "<end_time>" request.limit = <limit> request.offset = <offset> 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 39 40 41 42 43 |
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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := dcs.NewDcsClient( dcs.DcsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListBackupRecordsRequest{} beginTimeRequest:= "<begin_time>" request.BeginTime = &beginTimeRequest endTimeRequest:= "<end_time>" request.EndTime = &endTimeRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest offsetRequest:= int32(<offset>) request.Offset = &offsetRequest response, err := client.ListBackupRecords(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
DCS instance backup records queried successfully. |
204 |
No DCS instance backup record is found. |
400 |
Invalid request. |
500 |
Internal service error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot