Help Center/ CodeArts Deploy/ API Reference/ APIs/ Managing Applications/ Obtaining the Details of an Application

Updated on 2025-08-18 GMT+08:00

View PDF

Obtaining the Details of an Application

Function

This API is used to obtain application details by deployment task ID. This API will not be maintained after September 30, 2024. You can use the ShowAppDetailById API instead.

Calling Method

For details, see Calling APIs.

URI

GET /v2/tasks/{task_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
task_id	Yes	String	Definition: Deployment task ID. Constraints: N/A. Value range: 32 characters, including letters and digits. Default value: N/A.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition: User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API used forObtaining a User Token. Constraints: N/A. Value range: String. Max. 20,000 characters. Default value: N/A.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
task_id	String	Definition: Deployment task ID. Value range: 32 characters, including letters and digits.
name	String	Definition: Application name. Value range: 3 to 128 characters, including letters, digits, hyphens (-), and underscores (_).
project_id	String	Definition: Project ID. Value range: 32 characters, including letters and digits.
project_name	String	Definition: Project name. Value range: 3 to 128 characters.
deploy_system	String	Definition: Deployment type mode. Value range: deployTemplate: Deployment template type.
create_time	String	Definition: Creation time. Format: yyyy-MM-dd HH:mm:ss. Value range: N/A.
update_time	String	Definition: Modification time. Format: yyyy-MM-dd HH:mm:ss. Value range: N/A.
state	String	Definition: Application status. Value range: Draft: The application is in draft. Available: The application is available.
execution_time	String	Definition: Last deployment time of the application. Format: yyyy-MM-dd HH:mm:ss. Value range: N/A.
description	String	Definition: Description. Value range: Max. 1,024 characters.
is_defaut_permission	Boolean	Definition: Whether you are the default role of the project management. Value range: true: Yes. false: No.
template_id	String	Definition: Template ID. Value range: 32 characters, including letters and digits.
owner	String	Definition: Username of the application creator. Value range: Max. 128 characters.
nick_name	String	Definition: Nickname of the application creator. Value range: Max. 128 characters.
owner_id	String	Definition: Application creator ID. Value range: 32 characters, including letters and digits.
tenant_id	String	Definition: Tenant ID of the application creator. Value range: 32 characters, including letters and digits.
tenant_name	String	Definition: Tenant name of the application creator. Value range: Max. 128 characters.
slave_cluster_id	String	Definition: ID of slave cluster. Value range: 32 characters, including letters and digits.
is_care	Boolean	Definition: Whether you have favorited the application. Value range: true: Yes. false: No.
can_modify	Boolean	Definition: Whether you have the edit permission. Value range: true: Yes. false: No.
can_delete	Boolean	Definition: Whether you have the delete permission. Value range: true: Yes. false: No.
can_view	Boolean	Definition: Whether you have the view permission. Value range: true: Yes. false: No.
can_execute	Boolean	Definition: Whether you have the deployment permission. Value range: true: Yes. false: No.
can_copy	Boolean	Definition: Whether you have the copy permission. Value range: true: Yes. false: No.
can_manage	Boolean	Definition: Whether you have permission to edit the application permission matrix. Value range: true: Yes. false: No.
can_disable	Boolean	Definition: Whether you have permission to disable applications. Value range: true: Yes. false: No.
app_component_list	Array of AppComponentDao objects	Definition: Application component list.
role_id	Integer	Definition: Project management role ID. Value range: N/A.
id	String	Definition: Deployment task ID. Value range: 32 characters, including letters and digits.
release_id	Integer	Definition: Deployment record sequence number. Value range: N/A.
app_id	String	Definition: Deployment application ID. Value range: 32 characters, including letters and digits.
is_disable	Boolean	Definition: Whether the application is disabled. Value range: true: Yes. false: No.
duration	String	Definition: Deployment duration. Format: HH:mm:ss. Value range: N/A.
execution_state	String	Definition: Last execution status of the application. Value range: abort: Deployment suspended. failed: Deployment failed. not_started: Execution canceled. pending: Queuing. running: Deployment in progress. succeeded: Deployment succeeded.
executor_id	String	Definition: Deployer ID. Value range: N/A.
executor_nick_name	String	Definition: Deployer nickname. Value range: N/A.
steps	Map<String,Step>	Definition: Deployment action.

**Table 4** AppComponentDao
Parameter	Type	Description
task_id	String	Parameter description: Deployment application ID. Value range: The value consists of 32 characters. Letters and digits are allowed.
app_id	String	Parameter description: AOM application ID. Value range: The value consists of 32 characters. Letters and digits are allowed.
app_name	String	Parameter description: AOM application name. Value range: The value consists of letters and digits.
comp_id	String	Parameter description: AOM application component ID. Value range: The value consists of 32 characters. Letters and digits are allowed.
comp_name	String	Parameter description: AOM application component name. Value range: The value consists of 0 to 128 characters.
domain_id	String	Parameter description: Tenant ID. Value range: The value consists of 32 characters. Letters and digits are allowed.
region	String	Parameter description: Region information. Value range: The value consists of 1 to 256 characters.
state	String	Parameter description: Whether the AOM application component takes effect. Value range: 0: Initialized. 1: The operation is successful and takes effect.

**Table 5** Step
Parameter	Type	Description
id	String	Parameter description: Action ID. Value range: N/A
name	String	Parameter description: Action name. Value range: N/A
params	Map<String,String>	Parameter description: Action parameter. Value range: N/A
enable	Boolean	Definition: Whether to enable an action. Value range: true: Yes. false: No.

Example Requests

https://{endpoint}/v2/tasks/d2dc947ec2424d8789bb3984bb3adf45

Example Responses

Status code: 200

OK: The request is successful.

{
  "task_id" : "d2dc947ec2424d8789bb3984bb3adf45",
  "name" : "wyktest111",
  "state" : "Available",
  "description" : "111222",
  "owner" : "devcloud_devcloud_l00490255_01",
  "steps" : {
    "step1" : {
      "id" : "1583",
      "name" : "Select a deployment source",
      "params" : { },
      "enable" : true
    },
    "step2" : {
      "id" : "1293",
      "name" : "Health Test via URLs",
      "params" : { },
      "enable" : true
    }
  },
  "project_id" : "6039d4480efc4dddb178abff98719913",
  "project_name" : "wyk_test",
  "deploy_system" : "deployTemplate",
  "create_time" : "2021-04-01 17:07:49",
  "update_time" : "2021-05-17 11:26:58",
  "role_id" : 0,
  "is_defaut_permission" : false,
  "template_id" : "242ea879b3444b8391c3feb2e9c073de",
  "nick_name" : "A/B Side Account",
  "owner_id" : "6baa7454109d47c192f22078fe6cda20",
  "tenant_id" : "26a680dd72e7482eb60d2ef5513588bb",
  "tenant_name" : "devcloud_devcloud_l00490255_01",
  "slave_cluster_id" : "",
  "is_care" : false,
  "can_modify" : true,
  "can_delete" : true,
  "can_view" : true,
  "can_execute" : true,
  "can_copy" : true,
  "can_manage" : true,
  "can_disable" : false,
  "app_component_list" : [ ],
  "app_id" : "88ef50e1d931450989c66adb09acc81d",
  "is_disable" : true
}

SDK Sample Code

The SDK sample code is as follows.

Java

    
     
       
       
         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.codeartsdeploy.v2.region.CodeArtsDeployRegion;
import com.huaweicloud.sdk.codeartsdeploy.v2.*;
import com.huaweicloud.sdk.codeartsdeploy.v2.model.*;


public class ShowDeployTaskDetailSolution {

    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);

        CodeArtsDeployClient client = CodeArtsDeployClient.newBuilder()
                .withCredential(auth)
                .withRegion(CodeArtsDeployRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowDeployTaskDetailRequest request = new ShowDeployTaskDetailRequest();
        request.withTaskId("{task_id}");
        try {
            ShowDeployTaskDetailResponse response = client.showDeployTaskDetail(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());
        }
    }
}

        

      

    
   

Python

    
     
       
       
         # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcodeartsdeploy.v2.region.codeartsdeploy_region import CodeArtsDeployRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcodeartsdeploy.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"]

    credentials = BasicCredentials(ak, sk)

    client = CodeArtsDeployClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CodeArtsDeployRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowDeployTaskDetailRequest()
        request.task_id = "{task_id}"
        response = client.show_deploy_task_detail(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

        

      

    
   

Go

    
     
       
       
         package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    codeartsdeploy "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/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 := codeartsdeploy.NewCodeArtsDeployClient(
        codeartsdeploy.CodeArtsDeployClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowDeployTaskDetailRequest{}
	request.TaskId = "{task_id}"
	response, err := client.ShowDeployTaskDetail(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: The request is successful.

Error Codes

See Error Codes.

Parent topic: Managing Applications

Previous topic: Deploying an Application

Next topic: Deleting an Application

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot