Querying Task Failure Information
Function
Queries information about failed tasks, such as binding and unbinding tasks.
Calling Method
For details, see Calling APIs.
URI
GET /v3/{project_id}/failed-tasks
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
Integer |
Specifies the number of items displayed per page. Default value: 1000 |
offset |
No |
Integer |
Offset of the failed task information list. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. Can be obtained by calling the IAM API for obtaining the user token (the value of X-Subject-Token in the response header). |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total |
Integer |
Total number of failed tasks. |
tasks |
Array of FailedTasks objects |
List of failed tasks. |
Parameter |
Type |
Description |
---|---|---|
task_id |
String |
VM ID. |
operate_type |
String |
Operation type of a task. It can be: - FAILED_RESET: reset - FAILED_REPLACE: replace - FAILED_UNBIND: unbind |
task_time |
String |
Task time |
task_error_code |
String |
Error code of a task failure |
task_error_msg |
String |
Error code of a task failure |
server_name |
String |
VM Name |
server_id |
String |
VM ID. |
keypair_name |
String |
Key pair name |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error Codes |
error_msg |
String |
Description |
Example Requests
None
Example Responses
Status code: 200
OK
{ "total" : 1, "tasks" : [ { "task_id" : "aee8d2fe-5484-4753-9177-5a38dc15546c", "operate_type" : "RUNNING_RESET", "task_time" : "1523342130000", "task_error_code" : null, "task_error_msg" : "Update public key error", "server_name" : "Test", "server_id" : "c9aa197b-a6b6-4c33-b3a6-fa0b4ec50006", "keypair_name" : "KeyPair-xt" } ] }
Status code: 400
Error response
{ "error_code" : "KPS.XXX", "error_msg" : "XXX" }
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 |
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.kps.v3.region.KpsRegion; import com.huaweicloud.sdk.kps.v3.*; import com.huaweicloud.sdk.kps.v3.model.*; public class ListFailedTaskSolution { 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); KpsClient client = KpsClient.newBuilder() .withCredential(auth) .withRegion(KpsRegion.valueOf("<YOUR REGION>")) .build(); ListFailedTaskRequest request = new ListFailedTaskRequest(); request.withLimit(<limit>); request.withOffset(<offset>); try { ListFailedTaskResponse response = client.listFailedTask(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 huaweicloudsdkkps.v3.region.kps_region import KpsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkkps.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"] credentials = BasicCredentials(ak, sk) client = KpsClient.new_builder() \ .with_credentials(credentials) \ .with_region(KpsRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListFailedTaskRequest() request.limit = <limit> request.offset = <offset> response = client.list_failed_task(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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" kps "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kps/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kps/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kps/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 := kps.NewKpsClient( kps.KpsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListFailedTaskRequest{} limitRequest:= int32(<limit>) request.Limit = &limitRequest offsetRequest:= int32(<offset>) request.Offset = &offsetRequest response, err := client.ListFailedTask(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 |
OK |
400 |
Error response |
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