文档首页/ 部署 CodeArts Deploy/ API参考/ API/ 环境管理/ 查询应用下环境列表
更新时间:2025-08-18 GMT+08:00

查询应用下环境列表

功能介绍

查询应用下环境列表。

调用方法

请参见如何调用API

URI

GET /v1/applications/{application_id}/environments

表1 路径参数

参数

是否必选

参数类型

描述

application_id

String

参数解释

应用id。

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目id,获取方式请参见获取项目id

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

page_index

Integer

参数解释

分页页码,表示从此页开始查询。

约束限制

不涉及。

取值范围

取值为[1~50]。

默认取值

不涉及。

page_size

Integer

参数解释

每页显示的条目数量。

约束限制

不涉及。

取值范围

取值为[1~100]。

默认取值

不涉及。

name

String

参数解释

要查询的环境名称。

约束限制

不涉及。

取值范围

最大长度为128个字符。

默认取值

不涉及。

sort_key

String

参数解释

排序字段。

约束限制

不涉及。

取值范围

  • NAME: 环境名称排序。

  • USER_NAME: 用户名称排序。

  • CREATED_TIME: 创建时间排序。

  • NICK_NAME: 用户昵称排序。

默认取值

不涉及。

sort_dir

String

参数解释

排序顺序。

约束限制

不涉及。

取值范围

  • DESC: 降序。

  • ASC: 升序。

默认取值

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

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

约束限制

不涉及。

取值范围

字符串,长度不超过20000个字符。

默认取值

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

status

String

参数解释

请求成功失败状态。

取值范围

  • success: 请求成功。

  • failed: 请求失败。

total

Integer

参数解释

符合条件的环境数量。

取值范围

0-100。

result

Array of EnvironmentDetail objects

参数解释

环境列表信息。

表5 EnvironmentDetail

参数

参数类型

描述

id

String

参数解释

环境id。

取值范围

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

name

String

参数解释

环境名称。

取值范围

不涉及。

description

String

参数解释

环境描述。

取值范围

不涉及。

os

String

参数解释

环境操作系统。

取值范围

  • windows:windows操作系统类型。

  • linux:linux操作系统类型。

project_id

String

参数解释

项目id。

取值范围

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

nick_name

String

参数解释

环境创建者用户昵称。

取值范围

不涉及。

deploy_type

Integer

参数解释

部署类型。

取值范围

  • 0: 主机类型。

  • 1: kubernetes类型。

created_time

String

参数解释

环境创建时间。时间格式:yyyy-MM-dd HH:mm:ss。

取值范围

不涉及。

instance_count

Integer

参数解释

环境下主机实例数量。

取值范围

不涉及。

created_by

UserInfo object

参数解释

环境创建者用户信息,包含用户id,用户名等。

permission

EnvironmentPermissionDetail object

参数解释

当前用户对环境的操作权限矩阵。

表6 UserInfo

参数

参数类型

描述

user_id

String

参数解释

用户id。

取值范围

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

user_name

String

参数解释

用户名。

取值范围

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

表7 EnvironmentPermissionDetail

参数

参数类型

描述

can_delete

Boolean

参数解释

当前用户是否有环境删除权限。

取值范围

  • true:有环境删除权限。

  • false:无环境删除权限。

can_deploy

Boolean

参数解释

当前用户是否有环境部署权限。

取值范围

  • true:有环境部署权限。

  • false:无环境部署权限。

can_edit

Boolean

参数解释

当前用户是否有环境编辑权限。

取值范围

  • true:有环境编辑权限。

  • false:无环境编辑权限。

can_manage

Boolean

参数解释

当前用户是否有环境权限矩阵编辑权限。

取值范围

  • true:有环境权限矩阵编辑权限。

  • false:无环境权限矩阵编辑权限。

can_view

Boolean

参数解释

当前用户是否有环境查看权限。

取值范围

  • true:有环境查看权限。

  • false:无环境查看权限。

请求示例

https://{endpoint}/v1/applications/43943381f7764c52baae8e697720873f/environments?project_id=55837d272adf4eee90319800e2da6961

响应示例

状态码:200

OK 请求响应成功

{
  "status" : "success",
  "total" : 1,
  "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",
    "project_id" : "55837d272adf4eee90319800e2da6961",
    "nick_name" : "AB边账号",
    "instance_count" : 1,
    "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
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 ListEnvironmentsSolution {

    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();
        ListEnvironmentsRequest request = new ListEnvironmentsRequest();
        request.withApplicationId("{application_id}");
        try {
            ListEnvironmentsResponse response = client.listEnvironments(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 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 = ListEnvironmentsRequest()
        request.application_id = "{application_id}"
        response = client.list_environments(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"
    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.ListEnvironmentsRequest{}
	request.ApplicationId = "{application_id}"
	response, err := client.ListEnvironments(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

OK 请求响应成功

错误码

请参见错误码