On this page

Function
Calling Method
URI
Request Parameters
Response Parameters
Example Requests
Example Responses
SDK Sample Code
Java
Python
Go
More
Status Codes
Error Codes

Show all

Help Center/ CodeArts Deploy/ API Reference/ APIs/ Managing Applications/ Obtaining Application Details (Recommended)

Obtaining Application Details (Recommended)

Updated on 2024-11-25 GMT+08:00

Online Debugging

CLI Examples

View PDF

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	Parameter description: Application ID. Constraints: N/A Value range: The value consists of 32 characters. Only letters and digits are allowed. Default value: N/A

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.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
result	AppDetailInfo object	Parameter description: Application details.
status	String	Parameter description: Request success or failure state. Value range: success: Request succeeded error: Request failed

**Table 4** AppDetailInfo
Parameter	Type	Description
id	String	Parameter description: Application ID. Value range: The value consists of 32 characters. Letters and digits are allowed.
name	String	Parameter description: Application name. Value range: The value consists of 3-128 characters. Only letters, digits,hyphens (-) and underscores (_) are allowed.
region	String	Parameter description: Region to which the application belongs. Value range: N/A
description	String	Parameter description: Description. Value range: The value consists of 0-1,024 characters.
is_disable	Boolean	Parameter description: Whether the application is disabled. Value range: true: Disabled false: Not disabled
create_type	String	Parameter description: Creation method. Value range: template: Flexible application orchestration
project_id	String	Parameter description: Project ID. Value range: The value consists of 32 characters. Letters and digits are allowed.
project_name	String	Parameter description: Project name. Value range: The value consists of 3 to 128 characters.
slave_cluster_id	String	Parameter description: Slave cluster ID. If the ID is left empty, the official resource pool is used by default. The self-hosted resource pool is used when the self-hosted resource pool slave cluster ID is transferred. Value range: The value consists of 1-32 characters. Letters and digits are allowed or the null value is transferred.
is_care	Boolean	Parameter description: Whether a user has favorited the application. Value range: true: Added to favorites false: Not added to favorites
can_modify	Boolean	Parameter description: Whether a user has the edit permission. Value range: true: With permission false: Without permission
can_delete	Boolean	Parameter description: Whether a user has the delete permission. Value range: true: With permission false: Without permission
can_view	Boolean	Parameter description: Whether a user has the view permission. Value range: true: With permission false: Without permission
can_execute	Boolean	Parameter description: Whether a user has the deploy permission. Value range: true: With permission false: Without permission
can_copy	Boolean	Parameter description: Whether a user has the clone permission. Value range: true: With permission false: Without permission
can_manage	Boolean	Parameter description: Whether a user has permission to edit the application permission matrix. Value range: true: With permission false: Without permission
can_create_env	Boolean	Parameter description: Whether a user has the permission to create environments. Value range: true: With permission false: Without permission
can_disable	Boolean	Parameter description: Whether a user has permission to disable applications. Value range: true: With permission false: Without permission
owner_tenant_id	String	Parameter description: Tenant ID of the application owner. Value range: The value consists of 1-32 characters. Letters and digits are allowed.
create_user_id	String	Parameter description: ID of the application creator. Value range: The value consists of 1-32 characters. Letters and digits are allowed.
create_tenant_id	String	Parameter description: Tenant ID of the application creator. Value range: The value consists of 1-32 characters. Letters and digits are allowed.
create_time	String	Parameter description: Creation time. The value format is yyyy-MM-dd HH:mm:ss. For example, 2021-02-25 10:37:27. Value range: N/A
update_time	String	Parameter description: Modification time. The value format is yyyy-MM-dd HH:mm:ss. For example, 2021-02-25 10:37:27. Value range: N/A
permission_level	String	Parameter description: Application authentication level. Value range: project: Authentication at project level instance: Authentication at instance level
arrange_infos	Array of TaskV2Info objects	Parameter description: Deployment task information.

**Table 5** TaskV2Info
Parameter	Type	Description
id	String	Parameter description: Deployment application ID. Value range: The value consists of 32 characters. Letters and digits are allowed.
name	String	Parameter description: Deployment task name. Value range: The value consists of 3-128 characters. Only letters, digits,hyphens (-) and underscores (_) are allowed.
state	String	Parameter description: Deployment task status. Value range: Available: Executable state Draft: Draft state
description	String	Parameter description: Description. Value range: The value consists of 0-1,024 characters.
owner	String	Parameter description: Deployment application owner. Value range: N/A
steps	Map<String,Step>	Parameter description: Deployment action.
project_id	String	Parameter description: Project ID. Value range: The value consists of 32 characters. Letters and digits are allowed.
project_name	String	Parameter description: Project name. Value range: The value consists of 3 to 128 characters.
deploy_system	String	Parameter description: Deployment mode. Value range: deployTemplate: Deployment template
create_time	String	Parameter description: Creation time. The value format is yyyy-MM-dd HH:mm:ss. For example, 2021-02-25 10:37:27. Value range: N/A
update_time	String	Parameter description: Modification time. The value format is yyyy-MM-dd HH:mm:ss. For example, 2021-02-25 10:37:27. Value range: N/A
role_id	Integer	Parameter description: Role ID. Value range: N/A
is_defaut_permission	Boolean	Parameter description: Whether a role is the default role. Value range: true: Yes false: No
template_id	String	Parameter description: Template ID. Value range: The value consists of 1-32 characters. Letters and digits are allowed.
nick_name	String	Parameter description: Nickname of the application creator. Value range: The value consists of 0 to 128 characters.
owner_id	String	Parameter description: ID of the application creator. Value range: The value consists of 1-32 characters. Letters and digits are allowed.
tenant_id	String	Parameter description: Tenant ID of the application creator. Value range: The value consists of 1-32 characters. Letters and digits are allowed.
tenant_name	String	Parameter description: Tenant name of the application creator. Value range: The value consists of 0 to 128 characters.
slave_cluster_id	String	Parameter description: Slave cluster ID. If the ID is left empty, the official resource pool is used by default. The self-hosted resource pool is used when the self-hosted resource pool slave cluster ID is transferred. Value range: The value consists of 1-32 characters. Letters and digits are allowed or the null value is transferred.
is_care	Boolean	Parameter description: Whether a user has favorited the application. Value range: true: Added to favorites false: Not added to favorites
can_modify	Boolean	Parameter description: Whether a user has the edit permission. Value range: true: With permission false: Without permission
can_delete	Boolean	Parameter description: Whether a user has the delete permission. Value range: true: With permission false: Without permission
can_view	Boolean	Parameter description: Whether a user has the view permission. Value range: true: With permission false: Without permission
can_execute	Boolean	Parameter description: Whether a user has the deploy permission. Value range: true: With permission false: Without permission
can_copy	Boolean	Parameter description: Whether a user has the clone permission. Value range: true: With permission false: Without permission
can_manage	Boolean	Parameter description: Whether a user has permission to edit the application permission matrix. Value range: true: With permission false: Without permission
can_create_env	Boolean	Parameter description: Whether a user has the permission to create environments. Value range: true: With permission false: Without permission
can_disable	Boolean	Parameter description: Whether a user has permission to disable applications. Value range: true: With permission false: Without permission
app_component_list	Array of AppComponentDao objects	Parameter description: Application component list.
release_id	Integer	Parameter description: Deployment record sequence number. Value range: N/A
app_id	String	Parameter description: Deployment task ID. Value range: The value consists of 32 characters. Letters and digits are allowed.
is_disable	Boolean	Parameter description: Whether the application is disabled. Value range: true: Disabled false: Not disabled

**Table 6** 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	Parameter description: Whether an action is enabled. Value range: true: Enabled false: Disabled

**Table 7** 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.

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

    
     
       
       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

    
     
       
       # 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

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

      

    
   

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: Updating an Application

Next topic: Deleting an Application (Recommended)

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

Obtaining Application Details (Recommended)

Function

Calling Method

URI

Request Parameters

Response Parameters

Example Requests

Example Responses

SDK Sample Code

Java

Python

Go

More

Status Codes

Error Codes

Feedback

Was this page helpful?

Feedback