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

查询环境详情

功能介绍

查询环境详情。

调用方法

请参见如何调用API

URI

GET /v1/applications/{application_id}/environments/{environment_id}

表1 路径参数

参数

是否必选

参数类型

描述

application_id

String

应用id

environment_id

String

环境id

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

status

String

请求成功失败状态

result

EnvironmentDetail object

环境详情

表4 EnvironmentDetail

参数

参数类型

描述

id

String

环境id

name

String

环境名称

description

String

环境描述

os

String

操作系统

nick_name

String

用户昵称

deploy_type

Integer

部署类型:0表示主机, 1表示kubernetes

created_time

String

创建时间

instance_count

Integer

环境下主机实例数量

created_by

UserInfo object

参数解释

用户信息,包含用户id、用户名等。

约束限制

不涉及。

permission

EnvironmentPermissionDetail object

环境权限详情

表5 UserInfo

参数

参数类型

描述

user_id

String

参数解释

用户id。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

user_name

String

参数解释

用户名。

取值范围

只能由英文字母、数字组成,且长度为[1-255]个字符。

表6 EnvironmentPermissionDetail

参数

参数类型

描述

can_delete

Boolean

是否有删除环境权限

can_deploy

Boolean

是否有部署权限

can_edit

Boolean

是否有编辑环境权限

can_manage

Boolean

是否有编辑环境权限矩阵的权限

can_view

Boolean

是否有环境的查看权限

请求示例

https://{endpoint}/v1/applications/43943381f7764c52baae8e697720873f/environments/140ca97e701d4c4c93c5932d5bdb32ec

响应示例

状态码: 200

OK 请求响应成功

{
  "status" : "success",
  "result" : {
    "created_by" : {
      "user_id" : "6baa7454109d47c192f22078fe6cda20",
      "user_name" : "devcloud_devcloud_l00490255_01"
    },
    "created_time" : "2023-06-20 16:53:29.0",
    "deploy_type" : 0,
    "description" : "",
    "id" : "a0a2274acc4f482bb2ecf49f865879fa",
    "name" : "casdasd",
    "nick_name" : "AB边账号",
    "os" : "linux",
    "permission" : {
      "can_delete" : true,
      "can_deploy" : true,
      "can_edit" : true,
      "can_manage" : true,
      "can_view" : true
    }
  }
}

SDK代码示例

SDK代码示例如下。

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
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.codeartsdeploy.v2.region.CodeArtsDeployRegion;
import com.huaweicloud.sdk.codeartsdeploy.v2.*;
import com.huaweicloud.sdk.codeartsdeploy.v2.model.*;


public class ShowEnvironmentDetailSolution {

    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();
        ShowEnvironmentDetailRequest request = new ShowEnvironmentDetailRequest();
        request.withApplicationId("{application_id}");
        request.withEnvironmentId("{environment_id}");
        try {
            ShowEnvironmentDetailResponse response = client.showEnvironmentDetail(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
32
# 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 = ShowEnvironmentDetailRequest()
        request.application_id = "{application_id}"
        request.environment_id = "{environment_id}"
        response = client.show_environment_detail(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
37
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.ShowEnvironmentDetailRequest{}
	request.ApplicationId = "{application_id}"
	request.EnvironmentId = "{environment_id}"
	response, err := client.ShowEnvironmentDetail(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

OK 请求响应成功

错误码

请参见错误码