更新时间:2024-11-26 GMT+08:00

根据环境名称查询环境详情

功能介绍

该接口用于查询环境详情。

调用方法

请参见如何调用API

URI

GET /v1/environments/name/{environment_name}

表1 路径参数

参数

是否必选

参数类型

描述

environment_name

String

环境名称

表2 Query参数

参数

是否必选

参数类型

描述

region

String

环境region

component_id

String

组件id

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

从IAM服务获取的用户Token

Content-Type

String

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

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

aom_id

String

aomId

component_id

String

组件Id

create_time

String

创建时间

creator

String

创建者

description

String

描述

env_id

String

环境Id

env_name

String

环境名称

env_tags

Array of TagNameAndIdVo objects

环境标签

env_type

String

环境类型

eps_id

String

企业项目Id

modified_time

String

修改时间

modifier

String

修改者

os_type

String

os类型

region

String

区域

register_type

String

注册方式

枚举值:

  • API

  • CONSOLE

  • SERVICE_DISCOVERY

表5 TagNameAndIdVo

参数

参数类型

描述

tag_id

String

标签Id

tag_name

String

标签名称

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

AOM.30005001

error_msg

String

参数错误

状态码: 403

表7 响应Body参数

参数

参数类型

描述

error_code

String

AOM.30001005

error_msg

String

没有权限

请求示例

根据环境名称查询环境信息

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

响应示例

状态码: 200

环境信息详情

{
  "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" : "环境描述",
  "component_id" : "28c600be47374b9697404b0f58263d1c",
  "os_type" : "LINUX",
  "env_type" : "DEV",
  "eps_id" : null,
  "aom_id" : null,
  "env_tags" : null
}

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

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

状态码

状态码

描述

200

环境信息详情

400

参数异常

403

没有权限

错误码

请参见错误码