Obtaining a List of Cluster Backup Task Details
Function
Obtain a list of cluster backup task details.
Calling Method
For details, see Calling APIs.
URI
GET /api/v3.1/projects/{project_id}/clusters/{cluster_id}/operation/snapshot/tasks
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI. |
cluster_id |
Yes |
String |
Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI. |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
apiVersion |
String |
API version, which defaults to v3.1 |
kind |
String |
Task type |
metadata |
SnapshotTaskMetadata object |
Backup metadata |
items |
Array of SnapshotTask objects |
Backup tasks |
status |
SnapshotTaskStatus object |
Backup task status |
Parameter |
Type |
Description |
---|---|---|
kind |
String |
Task type |
apiVersion |
String |
API version |
metadata |
SnapshotTaskMetadata object |
Backup metadata |
spec |
SnapshotSpec object |
Backing Up Task Configurations (To Be Deprecated) |
status |
SnapshotStatus object |
Backup task status |
Parameter |
Type |
Description |
---|---|---|
uid |
String |
Task ID |
creationTimestamp |
String |
Time when the task was created |
updateTimestamp |
String |
Time when the task was updated |
Parameter |
Type |
Description |
---|---|---|
items |
Array of SnapshotSpecItems objects |
Backup task details |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Subtask ID |
type |
String |
Subtask type |
status |
String |
Status |
creationTimestamp |
String |
Time when the task was created |
updateTimestamp |
String |
Time when the task was updated |
message |
String |
Information |
Example Requests
None
Example Responses
Status code: 200
The list of cluster backup task details is obtained.
{ "kind" : "List", "apiVersion" : "v3.1", "metadata" : { }, "items" : [ { "kind" : "SnapshotTask", "apiVersion" : "v3.1", "metadata" : { "uid" : "87d326f9-46b0-486e-a4ba-1f82ec9315ed", "creationTimestamp" : "2023-11-25 17:03:46.739012 +0800 CST", "updateTimestamp" : "2023-11-25 17:03:46.739027 +0800 CST" }, "spec" : { }, "status" : { "phase" : "Running", "progress" : "67", "completionTime" : "2023-11-25 17:03:46.739027 +0800 CST" } } ], "status" : { "latestBackupTime" : "2023-11-25 17:03:47.980844 +0800 CST" } }
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 |
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.cce.v3.region.CceRegion; import com.huaweicloud.sdk.cce.v3.*; import com.huaweicloud.sdk.cce.v3.model.*; public class ListClusterMasterSnapshotTasksSolution { 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); CceClient client = CceClient.newBuilder() .withCredential(auth) .withRegion(CceRegion.valueOf("<YOUR REGION>")) .build(); ListClusterMasterSnapshotTasksRequest request = new ListClusterMasterSnapshotTasksRequest(); request.withClusterId("{cluster_id}"); try { ListClusterMasterSnapshotTasksResponse response = client.listClusterMasterSnapshotTasks(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 huaweicloudsdkcce.v3.region.cce_region import CceRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcce.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 = CceClient.new_builder() \ .with_credentials(credentials) \ .with_region(CceRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListClusterMasterSnapshotTasksRequest() request.cluster_id = "{cluster_id}" response = client.list_cluster_master_snapshot_tasks(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" cce "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/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 := cce.NewCceClient( cce.CceClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListClusterMasterSnapshotTasksRequest{} request.ClusterId = "{cluster_id}" response, err := client.ListClusterMasterSnapshotTasks(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 |
The list of cluster backup task details is obtained. |
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