Help Center/ Application Operations Management/ API Reference/ APIs/ CMDB (AOM 2.0)/ Querying the Details of an Application Based on the Application Name
Updated on 2024-06-28 GMT+08:00

Querying the Details of an Application Based on the Application Name

Function

This API is used to query the details of an application.

Calling Method

For details, see Calling APIs.

URI

GET /v1/applications

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

name

No

String

Unique application ID, which contains 2 to 64 characters. Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed. You need to enter a unique application ID or display name.

display_name

No

String

Display name, which contains 2 to 64 characters. Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed. You need to enter a unique application ID or display name.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token obtained from IAM.

Content-Type

Yes

String

Content type, which is application/json. This parameter is mandatory only when the body exists.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

aom_id

String

AOM ID. If you leave this parameter empty, it will not be displayed.

app_id

String

Application ID.

create_time

String

Creation time.

creator

String

Creator.

description

String

Description.

display_name

String

Application name.

eps_id

String

Enterprise project ID.

modified_time

String

Modification time.

modifier

String

User who makes the modification.

name

String

Unique identifier.

register_type

String

Registration method.

Enumeration values:

  • API

  • CONSOLE

  • SERVICE_DISCOVERY

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

AOM.30005001

error_msg

String

Invalid parameters.

Status code: 403

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

AOM.30001005

error_msg

String

No permissions.

Example Requests

Query the details of an application based on the application name.

https://{Endpoint}/v1/applications

{
  "name" : "exampleSW12"
}

Example Responses

Status code: 200

Application details.

{
  "creator" : "xxx",
  "modifier" : "xxx",
  "name" : "exampleSW12",
  "description" : "Application information.",
  "create_time" : "2023-02-03 10:35:00",
  "modified_time" : "2023-02-03 10:41:49",
  "register_type" : "API",
  "display_name" : "exampleSW12",
  "app_id" : "9616a75c75af4bcdacf38d77ff72a88e",
  "eps_id" : "0"
}

SDK Sample Code

The SDK sample code is as follows.

Java

Query the details of an application based on the application name.

 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
47
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.aom.v3.region.AomRegion;
import com.huaweicloud.sdk.aom.v3.*;
import com.huaweicloud.sdk.aom.v3.model.*;


public class ShowAppByNameSolution {

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

        AomClient client = AomClient.newBuilder()
                .withCredential(auth)
                .withRegion(AomRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowAppByNameRequest request = new ShowAppByNameRequest();
        request.withName("<name>");
        request.withDisplayName("<display_name>");
        try {
            ShowAppByNameResponse response = client.showAppByName(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

Query the details of an application based on the application name.

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkaom.v3.region.aom_region import AomRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkaom.v3 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 = AomClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(AomRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowAppByNameRequest()
        request.name = "<name>"
        request.display_name = "<display_name>"
        response = client.show_app_by_name(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

Query the details of an application based on the application name.

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

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

    request := &model.ShowAppByNameRequest{}
	nameRequest:= "<name>"
	request.Name = &nameRequest
	displayNameRequest:= "<display_name>"
	request.DisplayName = &displayNameRequest
	response, err := client.ShowAppByName(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

Application details.

400

Invalid parameters.

403

No permissions.

Error Codes

See Error Codes.