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

Querying the Details of an Environment Based on the Environment Name

Function

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

Calling Method

For details, see Calling APIs.

URI

GET /v1/environments/name/{environment_name}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

environment_name

Yes

String

Environment name.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

region

Yes

String

Region associated with the environment.

component_id

Yes

String

Component ID.

Request Parameters

Table 3 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 4 Response body parameters

Parameter

Type

Description

aom_id

String

aomId

component_id

String

Component ID.

create_time

String

Creation time.

creator

String

Creator.

description

String

Description.

env_id

String

Environment ID.

env_name

String

Environment name.

env_tags

Array of TagNameAndIdVo objects

Environment tag.

env_type

String

Environment type.

eps_id

String

Enterprise project ID.

modified_time

String

Modification time.

modifier

String

User who makes the modification.

os_type

String

OS type.

region

String

Region.

register_type

String

Registration method.

Table 5 TagNameAndIdVo

Parameter

Type

Description

tag_id

String

Tag ID.

tag_name

String

Tag name.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

AOM.30005001

error_msg

String

Invalid parameters.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

AOM.30001005

error_msg

String

No permissions.

Example Requests

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

https://{Endpoint}/v1/environments/name/111?component_id=b879dd3d5f8942699814fdf84eb6464f&region=xxx

Example Responses

Status code: 200

Environment details.

{
  "creator" : "xxx",
  "modifier" : "xxx",
  "region" : "xxx",
  "create_time" : "2023-02-03 11:17:19",
  "modified_time" : "2023-02-03 11:17:19",
  "register_type" : "API",
  "env_name" : "environment1",
  "env_id" : "530312e8bd7c4674b0af6d4beb2e23c6",
  "description" : "Environment description.",
  "component_id" : "28c600be47374b9697404b0f58263d1c",
  "os_type" : "LINUX",
  "env_type" : "DEV",
  "eps_id" : null,
  "aom_id" : null,
  "env_tags" : null
}

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


public class ShowEnvByNameSolution {

    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();
        ShowEnvByNameRequest request = new ShowEnvByNameRequest();
        request.withEnvironmentName("{environment_name}");
        try {
            ShowEnvByNameResponse response = client.showEnvByName(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 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 = ShowEnvByNameRequest()
        request.environment_name = "{environment_name}"
        response = client.show_env_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

 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"
    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.ShowEnvByNameRequest{}
	request.EnvironmentName = "{environment_name}"
	response, err := client.ShowEnvByName(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

Environment details.

400

Invalid parameters.

403

No permissions.

Error Codes

See Error Codes.