Querying the Job Execution Result of a Tenant
Function
This API is used to query the task execution result.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
 - If you are using identity policy-based authorization, the following identity policy-based permissions are required. 
     
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
dcs:job:get
Read
-
-
-
-
 
URI
GET /v2/{project_id}/jobs/{job_id}
| 
         Parameter  | 
       
         Mandatory  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|---|
| 
         project_id  | 
       
         Yes  | 
       
         String  | 
       
         Definition Project ID. For details, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A  | 
      
| 
         job_id  | 
       
         Yes  | 
       
         String  | 
       
         Definition Task ID. Constraints N/A Range N/A Default Value N/A  | 
      
Request Parameters
None
Response Parameters
Status code: 200
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         job_id  | 
       
         String  | 
       
         Definition Task ID. Range N/A  | 
      
| 
         job_type  | 
       
         String  | 
       
         Definition Job type. Range 
  | 
      
| 
         status  | 
       
         String  | 
       
         Definition Job status. Range 
  | 
      
| 
         begin_time  | 
       
         String  | 
       
         Definition Job start timestamp, in ms. The format is 1684191545379. Range N/A  | 
      
| 
         end_time  | 
       
         String  | 
       
         Definition Job start timestamp, in ms. The format is 1684191548248. Range N/A  | 
      
| 
         fail_reason  | 
       
         String  | 
       
         Definition Failure cause. Range N/A  | 
      
Status code: 400
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error_msg  | 
       
         String  | 
       
         Definition Error information. Range N/A  | 
      
| 
         error_code  | 
       
         String  | 
       
         Definition Error code. Range For details, see Error Codes.  | 
      
| 
         error_ext_msg  | 
       
         String  | 
       
         Definition Extended error information. This parameter is not used currently and is set to null. Range N/A  | 
      
Status code: 401
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error_msg  | 
       
         String  | 
       
         Definition Error information. Range N/A  | 
      
| 
         error_code  | 
       
         String  | 
       
         Definition Error code. Range For details, see Error Codes.  | 
      
| 
         error_ext_msg  | 
       
         String  | 
       
         Definition Extended error information. This parameter is not used currently and is set to null. Range N/A  | 
      
Status code: 403
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error_msg  | 
       
         String  | 
       
         Definition Error information. Range N/A  | 
      
| 
         error_code  | 
       
         String  | 
       
         Definition Error code. Range For details, see Error Codes.  | 
      
| 
         error_ext_msg  | 
       
         String  | 
       
         Definition Extended error information. This parameter is not used currently and is set to null. Range N/A  | 
      
Status code: 404
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error_msg  | 
       
         String  | 
       
         Definition Error information. Range N/A  | 
      
| 
         error_code  | 
       
         String  | 
       
         Definition Error code. Range For details, see Error Codes.  | 
      
| 
         error_ext_msg  | 
       
         String  | 
       
         Definition Extended error information. This parameter is not used currently and is set to null. Range N/A  | 
      
Status code: 500
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error_msg  | 
       
         String  | 
       
         Definition Error information. Range N/A  | 
      
| 
         error_code  | 
       
         String  | 
       
         Definition Error code. Range For details, see Error Codes.  | 
      
| 
         error_ext_msg  | 
       
         String  | 
       
         Definition Extended error information. This parameter is not used currently and is set to null. Range N/A  | 
      
Example Requests
GET https://{dcs_endpoint}/v2/{project_id}/jobs/{job_id}
  Example Responses
Status code: 200
Details of the background task queried successfully.
{
  "job_id" : "ff8080818822bbf70188235afc24141a",
  "job_type" : "masterStandbySwapJob",
  "status" : "SUCCESS",
  "begin_time" : "1684191545379",
  "end_time" : "1684191548248",
  "fail_reason" : null
}
   Status code: 400
Invalid request.
{
  "error_code" : "111400063",
  "error_msg" : "Invalid {0} parameter in the request."
}
  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.dcs.v2.region.DcsRegion; import com.huaweicloud.sdk.dcs.v2.*; import com.huaweicloud.sdk.dcs.v2.model.*; public class ShowJobInfoSolution { 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(); ShowJobInfoRequest request = new ShowJobInfoRequest(); request.withJobId("{job_id}"); try { ShowJobInfoResponse response = client.showJobInfo(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 = ShowJobInfoRequest() request.job_id = "{job_id}" response = client.show_job_info(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.ShowJobInfoRequest{} request.JobId = "{job_id}" response, err := client.ShowJobInfo(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  | 
       
         Details of the background task queried successfully.  | 
      
| 
         400  | 
       
         Invalid request.  | 
      
| 
         401  | 
       
         Invalid authentication information.  | 
      
| 
         403  | 
       
         Request rejected.  | 
      
| 
         404  | 
       
         The requested resource could not be found.  | 
      
| 
         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