更新时间:2025-07-01 GMT+08:00
分享

获取应用详情

功能介绍

根据部署任务id获取应用详情。该接口于2024年09月30日后不再维护,推荐使用新版获取应用详(ShowAppDetailById)接口。

调用方法

请参见如何调用API

URI

GET /v2/tasks/{task_id}

表1 路径参数

参数

是否必选

参数类型

描述

task_id

String

参数解释

部署任务id。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制

不涉及。

取值范围

字符串,长度不超过20000个字符。

默认取值

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

task_id

String

参数解释

部署任务id。

取值范围

由英文字母、数字组成,且长度为32个字符。

name

String

参数解释

应用名称。

取值范围

由中文、英文字母、数字、-、_组成,且长度为3~128个字符。

project_id

String

参数解释

项目id。

取值范围

由英文字母、数字组成,且长度为32个字符。

project_name

String

参数解释

项目名称。

取值范围

长度为3~128个字符。

deploy_system

String

参数解释

部署类型模式。

取值范围

  • deployTemplate: 部署模板类型。

create_time

String

参数解释

创建时间。时间格式:yyyy-MM-dd HH:mm:ss。

取值范围

不涉及。

update_time

String

参数解释

修改时间。时间格式:yyyy-MM-dd HH:mm:ss。

取值范围

不涉及。

state

String

参数解释

应用状态。

取值范围

  • Draft: 表示应用为草稿状态

  • Available: 表示应用为可用状态

execution_time

String

参数解释

应用最后一次部署时间。时间格式:yyyy-MM-dd HH:mm:ss。

取值范围

不涉及。

description

String

参数解释

描述。

取值范围

长度为0~1024个字符。

is_defaut_permission

Boolean

参数解释

当前用户是否为项目管理默认角色。

取值范围

  • true: 是

  • false: 否

template_id

String

参数解释

模板id。

取值范围

由英文字母、数字组成,且长度为32个字符。

owner

String

参数解释

应用创建者用户名。

取值范围

长度最长为128个字符。

nick_name

String

参数解释

应用创建者昵称。

取值范围

长度最长为128个字符。

owner_id

String

参数解释

应用创建者用户id。

取值范围

由英文字母、数字组成,且长度为32个字符。

tenant_id

String

参数解释

应用创建者租户id。

取值范围

由英文字母、数字组成,且长度为32个字符。

tenant_name

String

参数解释

应用创建者租户名。

取值范围

长度最长为128个字符。

slave_cluster_id

String

参数解释

slave集群id。

取值范围

由英文字母、数字组成,且长度为32个字符。

is_care

Boolean

参数解释

当前用户是否已收藏本应用。

取值范围

  • true: 已收藏

  • false: 未收藏

can_modify

Boolean

参数解释

当前用户是否有编辑权限。

取值范围

  • true: 有权限

  • false: 无权限

can_delete

Boolean

参数解释

当前用户是否有删除的权限。

取值范围

  • true: 有权限

  • false: 无权限

can_view

Boolean

参数解释

当前用户是否有查看权限。

取值范围

  • true: 有权限

  • false: 无权限

can_execute

Boolean

参数解释

当前用户是否有部署权限。

取值范围

  • true: 有权限

  • false: 无权限

can_copy

Boolean

参数解释

当前用户是否有复制权限。

取值范围

  • true: 有权限

  • false: 无权限

can_manage

Boolean

参数解释

当前用户是否有编辑应用权限矩阵的权限。

取值范围

  • true: 有权限

  • false: 无权限

can_disable

Boolean

参数解释

当前用户是否有禁用应用的权限。

取值范围

  • true: 有权限

  • false: 无权限

app_component_list

Array of AppComponentDao objects

参数解释

应用组件列表。

role_id

Integer

参数解释

项目管理角色id。

取值范围

不涉及。

id

String

参数解释

部署任务id。

取值范围

由英文字母、数字组成,且长度为32个字符。

release_id

Integer

参数解释

部署记录序列号。

取值范围

不涉及。

app_id

String

参数解释

部署应用id。

取值范围

由英文字母、数字组成,且长度为32个字符。

is_disable

Boolean

参数解释

当前应用是否被禁用。

取值范围

  • true: 被禁用

  • false: 未被禁用

duration

String

参数解释

部署用时,格式为:HH:mm:ss。

取值范围

不涉及。

execution_state

String

参数解释

应用最后一次执行状态。

取值范围

  • abort: 部署中止

  • failed: 部署失败

  • not_started: 取消执行

  • pending: 排队中

  • running: 正在部署

  • succeeded: 部署成功

executor_id

String

参数解释

部署者id。

取值范围

不涉及。

executor_nick_name

String

参数解释

部署者昵称。

取值范围

不涉及。

steps

Map<String,Step>

参数解释

部署步骤。

表4 AppComponentDao

参数

参数类型

描述

task_id

String

参数解释

部署任务id。

取值范围

由英文字母、数字组成,且长度为32个字符。

app_id

String

参数解释

AOM应用id。

取值范围

由英文字母、数字组成,且长度为32个字符。

app_name

String

参数解释

AOM应用名称。

取值范围

由英文字母、数字组成。

comp_id

String

参数解释

AOM应用组件id。

取值范围

由英文字母、数字组成,且长度为32个字符。

comp_name

String

参数解释

AOM应用组件名称。

取值范围

长度为[0,128]个字符。

domain_id

String

参数解释

租户id。

取值范围

由英文字母、数字组成,且长度为32个字符。

region

String

参数解释

局点信息。

取值范围

长度为[1,256]个字符。

state

String

参数解释

AOM应用组件是否生效。

取值范围

  • 0: 初始化

  • 1: 执行成功,已生效

表5 Step

参数

参数类型

描述

id

String

参数解释

步骤id。

取值范围

不涉及。

name

String

参数解释

步骤名称。

取值范围

不涉及。

params

Map<String,String>

参数解释

步骤参数。

取值范围

不涉及。

enable

Boolean

参数解释

步骤是否开启。

取值范围

  • true: 步骤已启用

  • false: 步骤未启用

请求示例

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

响应示例

状态码:200

OK 请求响应成功

{
  "task_id" : "d2dc947ec2424d8789bb3984bb3adf45",
  "name" : "wyktest111",
  "state" : "Available",
  "description" : "111222",
  "owner" : "devcloud_devcloud_l00490255_01",
  "steps" : {
    "step1" : {
      "id" : "1583",
      "name" : "选择部署来源",
      "params" : { },
      "enable" : true
    },
    "step2" : {
      "id" : "1293",
      "name" : "URL健康测试",
      "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" : "AB边账号",
  "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代码示例

SDK代码示例如下。

Java

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

 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
# 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

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

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK 请求响应成功

错误码

请参见错误码

相关文档