Help Center> CodeArts Deploy> API Reference> APIs> Managing Applications> Obtaining Application Details (Recommended)
Updated on 2024-07-05 GMT+08:00

Obtaining Application Details (Recommended)

Function

This API is used to obtain application details by ID.

Calling Method

For details, see Calling APIs.

URI

GET /v1/applications/{app_id}/info

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

app_id

Yes

String

Application ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Minimum: 0

Maximum: 20000

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

result

AppDetailInfo object

Application details

status

String

Request success or failure status

Table 4 AppDetailInfo

Parameter

Type

Description

id

String

Application ID

name

String

Application name

Minimum: 3

Maximum: 128

region

String

Region to which the application belongs

description

String

Description

Minimum: 0

Maximum: 1024

is_disable

Boolean

Whether the application is disabled

create_type

String

Algorithm type

project_id

String

Project ID. For details, see Obtaining a Project ID.

project_name

String

Project name

Minimum: 3

Maximum: 128

slave_cluster_id

String

Slave cluster ID. If the value is null, the default slave cluster is used. If slave is user-defined, the slave cluster ID is used.

is_care

Boolean

Whether you have favorited the application

can_modify

Boolean

Whether you have the edit permission

can_delete

Boolean

Whether you have the delete permission

can_view

Boolean

Whether you have the view permission

can_execute

Boolean

Whether you have the deploy permission

can_copy

Boolean

Whether you have the clone permission

can_manage

Boolean

Whether you have permission to edit the application permission matrix

can_create_env

Boolean

Whether you have the permission to create environments

can_disable

Boolean

Whether you have permission to disable applications

owner_tenant_id

String

Tenant ID of the application owner

create_user_id

String

Username of the application creator

create_tenant_id

String

Tenant ID of the application creator

create_time

String

Creation time

update_time

String

Modification time

permission_level

String

Permission level

arrange_infos

Array of TaskV2Info objects

Deployment task information

Table 5 TaskV2Info

Parameter

Type

Description

id

String

Deployment task ID

name

String

Task name

Minimum: 3

Maximum: 128

state

String

Deployment task status

description

String

Description

Minimum: 0

Maximum: 1024

owner

String

Deployment task owner

steps

Map<String,Step>

Deployment procedure

project_id

String

Project ID. For details, see Obtaining a Project ID.

project_name

String

Project name

Minimum: 3

Maximum: 128

deploy_system

String

Deployment type. Options: deployTemplate, ansible, and shell.

create_time

String

Creation time

update_time

String

Modification time

role_id

Integer

Role ID

is_defaut_permission

Boolean

Whether the role is a default one

template_id

String

Template ID

nick_name

String

Alias of the application creator

Minimum: 0

Maximum: 128

owner_id

String

ID of the application creator

tenant_id

String

Tenant ID of the application creator

tenant_name

String

Tenant name of the application creator

Minimum: 0

Maximum: 128

slave_cluster_id

String

Slave cluster ID. If the value is null, the default slave cluster is used. If slave is user-defined, the slave cluster ID is used.

is_care

Boolean

Whether you have favorited the application

can_modify

Boolean

Whether you have the edit permission

can_delete

Boolean

Whether you have the delete permission

can_view

Boolean

Whether you have the view permission

can_execute

Boolean

Whether you have the deploy permission

can_copy

Boolean

Whether you have the clone permission

can_manage

Boolean

Whether you have permission to edit the application permission matrix

can_create_env

Boolean

Whether you have the permission to create environments

can_disable

Boolean

Whether you have permission to disable applications

app_component_list

Array of AppComponentDao objects

Application component list

release_id

Integer

Deployment record sequence number

app_id

String

Deployment task ID

is_disable

Boolean

Whether the application is disabled

Table 6 Step

Parameter

Type

Description

id

String

id

name

String

Name

params

Map<String,String>

Parameter

enable

Boolean

Whether to enable this feature

Table 7 AppComponentDao

Parameter

Type

Description

task_id

String

Deployment task ID

app_id

String

AOM application ID

app_name

String

AOM application name

comp_id

String

AOM application component ID

comp_name

String

AOM application component name

Minimum: 0

Maximum: 128

domain_id

String

Tenant ID

region

String

Region information

Minimum: 1

Maximum: 256

state

String

Whether the AOM application component takes effect. 0: The component is initialized. 1: The execution is successful and the component has taken effect.

Minimum: 1

Maximum: 32

Example Requests

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

Example Responses

Status code: 200

OK: The request is successful.

{
  "result" : {
    "id" : "d9e0532073e2475dbed64b22e64f3b26",
    "name" : "deployenv202308211530723",
    "region" : "cn-north-7",
    "description" : "for_test",
    "is_disable" : true,
    "create_type" : "template",
    "project_id" : "1ff8aa6dda4643bd9cbdbb588fb24bde",
    "project_name" : "Test Item",
    "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" : "Install Go",
          "params" : { },
          "enable" : true
        },
        "step2" : {
          "id" : null,
          "name" : "Download Software Package",
          "params" : { },
          "enable" : true
        },
        "step3" : {
          "id" : null,
          "name" : "Stop Go Service",
          "params" : { },
          "enable" : true
        },
        "step4" : {
          "id" : null,
          "name" : "Start Go Service",
          "params" : { },
          "enable" : true
        },
        "step5" : {
          "id" : null,
          "name" : "Test Service",
          "params" : { },
          "enable" : true
        }
      },
      "project_id" : "1ff8aa6dda4643bd9cbdbb588fb24bde",
      "project_name" : "Test Item",
      "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" : "Alias",
      "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 Sample Code

The SDK sample code is as follows.

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
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();
        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
# 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()
        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
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{}
	response, err := client.ShowAppDetailById(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More

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.