更新时间:2024-08-21 GMT+08:00

根据应用名称查询应用详情

功能介绍

该接口用于查询应用详情。

调用方法

请参见如何调用API

URI

GET /v1/applications

表1 Query参数

参数

是否必选

参数类型

描述

name

String

应用唯一标识;字符集长度2-64,仅支持字符集:英文字母、数字、下划线、中划线、点;应用唯一标识与显示名称至少填写其一

display_name

String

实体的显示名称;字符集长度2-64,仅支持字符集:中文字符、英文字母、数字、下划线、中划线、点;应用唯一标识与显示名称至少填写其一

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

从IAM服务获取的用户Token。

Content-Type

String

指定类型为application/json,有Body体的情况下必选,没有Body体则无需填写和校验。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

aom_id

String

aomId,如果为空则不显示

app_id

String

应用ID

create_time

String

创建时间

creator

String

创建人

description

String

描述

display_name

String

应用名称

eps_id

String

企业项目id

modified_time

String

修改时间

modifier

String

修改人

name

String

唯一标识

register_type

String

注册方式

枚举值:

  • API

  • CONSOLE

  • SERVICE_DISCOVERY

状态码: 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

AOM.30005001

error_msg

String

参数错误

状态码: 403

表5 响应Body参数

参数

参数类型

描述

error_code

String

AOM.30001005

error_msg

String

没有权限

请求示例

根据名称查询应用信息

https://{Endpoint}/v1/applications

{
  "name" : "exampleSW12"
}

响应示例

状态码: 200

应用详情

{
  "creator" : "xxx",
  "modifier" : "xxx",
  "name" : "exampleSW12",
  "description" : "应用信息",
  "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代码示例

SDK代码示例如下。

根据名称查询应用信息

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

根据名称查询应用信息

 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)

根据名称查询应用信息

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

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

状态码

状态码

描述

200

应用详情

400

参数异常

403

没有权限

错误码

请参见错误码