文档首页/ 部署 CodeArts Deploy/ API参考/ API/ 应用管理/ 获取应用详情 （推荐）
更新时间：2024-08-30 GMT+08:00
在线调试
CLI示例
查看PDF

获取应用详情 （推荐）

功能介绍

根据应用id获取应用详情。

调用方法

请参见如何调用API。

URI

GET /v1/applications/{app_id}/info

表1 路径参数

参数

是否必选

参数类型

描述

app_id

是

String

参数解释：

应用id。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

result

AppDetailInfo object

参数解释：

应用详情信息。

status

String

参数解释：

请求成功失败状态。

取值范围：

  • success: 成功

  • error: 失败
表4 AppDetailInfo

参数

参数类型

描述

id

String

参数解释：

应用id。

取值范围：

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

name

String

参数解释：

应用名称。

取值范围：

由中文字符、英文字母、数字及“_”、“-”组成，且长度为[3-128]个字符。

region

String

参数解释：

应用所属区域。

取值范围：

不涉及。

description

String

参数解释：

描述。

取值范围：

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

is_disable

Boolean

参数解释：

当前应用是否被禁用。

取值范围：

  • true: 被禁用

  • false: 未被禁用

create_type

String

参数解释：

创建方式。

取值范围：

  • template: 自由编排应用

project_id

String

参数解释：

项目id。

取值范围：

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

project_name

String

参数解释：

项目名称。

取值范围：

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

slave_cluster_id

String

参数解释：

slave集群id，默认为空时使用官方资源池池，传自托管资源池slave集群id时使用自托管资源池。

取值范围：

由英文字母、数字组成，且长度为[1,32]个字符或者为null。

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_create_env

Boolean

参数解释：

是否有创建环境的权限。

取值范围：

  • true: 有权限

  • false: 无权限

can_disable

Boolean

参数解释：

是否有禁用应用的权限。

取值范围：

  • true: 有权限

  • false: 无权限

owner_tenant_id

String

参数解释：

应用所属者租户id。

取值范围：

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

create_user_id

String

参数解释：

应用创建者用户id。

取值范围：

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

create_tenant_id

String

参数解释：

应用创建者租户id。

取值范围：

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

create_time

String

参数解释：

创建时间。格式为yyyy-MM-dd HH:mm:ss。例如：2021-02-25 10:37:27。

取值范围：

不涉及。

update_time

String

参数解释：

修改时间。格式为yyyy-MM-dd HH:mm:ss。例如：2021-02-25 10:37:27。

取值范围：

不涉及。

permission_level

String

参数解释：

应用鉴权级别。

取值范围：

  • project: 项目级鉴权

  • instance: 实例级鉴权

arrange_infos

Array of TaskV2Info objects

参数解释：

部署任务信息。
表5 TaskV2Info

参数

参数类型

描述

id

String

参数解释：

部署任务id。

取值范围：

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

name

String

参数解释：

部署任务名称。

取值范围：

由中文字符、英文字母、数字及“_”、“-”组成，且长度为[3-128]个字符。

state

String

参数解释：

部署任务状态。

取值范围：

  • Available: 可执行状态

  • Draft: 草稿状态

description

String

参数解释：

描述。

取值范围：

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

owner

String

参数解释：

部署任务所属人。

取值范围：

不涉及。

steps

Map<String,Step>

参数解释：

部署步骤。

project_id

String

参数解释：

项目id。

取值范围：

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

project_name

String

参数解释：

项目名称。

取值范围：

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

deploy_system

String

参数解释：

部署类型模式。

取值范围：

  • deployTemplate: 部署模板

create_time

String

参数解释：

创建时间。格式为yyyy-MM-dd HH:mm:ss。例如：2021-02-25 10:37:27。

取值范围：

不涉及。

update_time

String

参数解释：

修改时间。格式为yyyy-MM-dd HH:mm:ss。例如：2021-02-25 10:37:27。

取值范围：

不涉及。

role_id

Integer

参数解释：

角色id。

取值范围：

不涉及。

is_defaut_permission

Boolean

参数解释：

是否为默认角色。

取值范围：

  • true: 是

  • false: 否

template_id

String

参数解释：

模板id。

取值范围：

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

nick_name

String

参数解释：

应用创建者昵称。

取值范围：

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

owner_id

String

参数解释：

应用创建者用户id。

取值范围：

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

tenant_id

String

参数解释：

应用创建者租户id。

取值范围：

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

tenant_name

String

参数解释：

应用创建者租户名。

取值范围：

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

slave_cluster_id

String

参数解释：

slave集群id，默认为空时使用官方资源池，传自托管资源池slave集群id时使用自托管资源池。

取值范围：

由英文字母、数字组成，且长度为[1,32]个字符或者为null。

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_create_env

Boolean

参数解释：

是否有创建环境的权限。

取值范围：

  • true: 有权限

  • false: 无权限

can_disable

Boolean

参数解释：

是否有禁用应用的权限。

取值范围：

  • true: 有权限

  • false: 无权限

app_component_list

Array of AppComponentDao objects

参数解释：

应用组件列表。

release_id

Integer

参数解释：

部署记录序列号。

取值范围：

不涉及。

app_id

String

参数解释：

部署任务所属应用id。

取值范围：

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

is_disable

Boolean

参数解释：

当前应用是否被禁用。

取值范围：

  • true: 被禁用

  • false: 未被禁用
表6 Step

参数

参数类型

描述

id

String

参数解释：

步骤id。

取值范围：

不涉及。

name

String

参数解释：

步骤名称。

取值范围：

不涉及。

params

Map<String,String>

参数解释：

步骤参数。

取值范围：

不涉及。

enable

Boolean

参数解释：

步骤是否开启。

取值范围：

  • true: 启用

  • false: 未启用
表7 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: 执行成功，已生效

请求示例

https://{endpoint}/v1/applications/d2dc947ec2424d8789bb3984bb3adf45/info

响应示例

状态码： 200

OK 请求响应成功

{
  "result" : {
    "id" : "d9e0532073e2475dbed64b22e64f3b26",
    "name" : "deployenv202308211530723",
    "region" : "cn-north-7",
    "description" : "for_test",
    "is_disable" : true,
    "create_type" : "template",
    "project_id" : "1ff8aa6dda4643bd9cbdbb588fb24bde",
    "project_name" : "测试项目",
    "slave_cluster_id" : null,
    "is_care" : false,
    "can_modify" : true,
    "can_delete" : true,
    "can_view" : true,
    "can_execute" : true,
    "can_copy" : true,
    "can_manage" : true,
    "can_create_env" : true,
    "can_disable" : true,
    "owner_tenant_id" : "208fbb09068e4820b9209ef9ff4da73d",
    "create_user_id" : "6baa7454109d47c192f22078fe6cda20",
    "create_tenant_id" : "26a680dd72e7482eb60d2ef5513588bb",
    "create_time" : "2023-08-21 15:30:51.0",
    "update_time" : "2023-08-21 15:30:51.0",
    "permission_level" : "instance",
    "arrange_infos" : [ {
      "id" : "685a6f3b80264e7d96f2ba308f8414e5",
      "name" : "deployenv202308211530723",
      "state" : "Draft",
      "description" : "for_test",
      "owner" : "devcloud_devcloud_l00490255_01",
      "steps" : {
        "step1" : {
          "id" : null,
          "name" : "安装GO语言",
          "params" : { },
          "enable" : true
        },
        "step2" : {
          "id" : null,
          "name" : "下载软件包",
          "params" : { },
          "enable" : true
        },
        "step3" : {
          "id" : null,
          "name" : "停止Go服务",
          "params" : { },
          "enable" : true
        },
        "step4" : {
          "id" : null,
          "name" : "启动Go服务",
          "params" : { },
          "enable" : true
        },
        "step5" : {
          "id" : null,
          "name" : "健康测试",
          "params" : { },
          "enable" : true
        }
      },
      "project_id" : "1ff8aa6dda4643bd9cbdbb588fb24bde",
      "project_name" : "测试项目",
      "deploy_system" : "deployTemplate",
      "create_time" : "2023-08-21 15:30:51",
      "update_time" : "2023-08-21 15:30:51",
      "role_id" : 0,
      "is_defaut_permission" : false,
      "template_id" : "681bd91f9d6e42cdb4cb84d6718de9fe",
      "nick_name" : "用户昵称",
      "owner_id" : "6baa7454109d47c192f22078fe6cda20",
      "tenant_id" : "26a680dd72e7482eb60d2ef5513588bb",
      "tenant_name" : "devcloud_devcloud_l00490255_01",
      "slave_cluster_id" : null,
      "is_care" : false,
      "can_modify" : true,
      "can_delete" : true,
      "can_view" : true,
      "can_execute" : true,
      "can_copy" : true,
      "can_manage" : true,
      "can_create_env" : false,
      "can_disable" : false,
      "app_component_list" : [ ],
      "release_id" : 0,
      "app_id" : "d9e0532073e2475dbed64b22e64f3b26",
      "is_disable" : true
    } ]
  },
  "status" : "success"
}

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

    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();
        ShowAppDetailByIdRequest request = new ShowAppDetailByIdRequest();
        request.withAppId("{app_id}");
        try {
            ShowAppDetailByIdResponse response = client.showAppDetailById(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 = ShowAppDetailByIdRequest()
        request.app_id = "{app_id}"
        response = client.show_app_detail_by_id(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.ShowAppDetailByIdRequest{}
	request.AppId = "{app_id}"
	response, err := client.ShowAppDetailById(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

OK 请求响应成功

错误码

请参见错误码。

父主题： 应用管理