文档首页/ 部署 CodeArts Deploy/ API参考/ API/ 环境管理/ 查询环境内的主机列表
更新时间:2025-11-17 GMT+08:00
分享

查询环境内的主机列表

功能介绍

查询环境内的主机列表。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

application_id

String

应用id

environment_id

String

环境id

表2 Query参数

参数

是否必选

参数类型

描述

key_field

String

主机名、ip关键字模糊搜索

as_proxy

Boolean

是否为代理机,true为代理机

page_index

Integer

分页页码

page_size

Integer

分页查询每页条数

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

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

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

status

String

参数解释

请求成功失败状态。

取值范围

  • success: 成功。

  • error: 失败。

total

Integer

参数解释

总数量。

取值范围

只能是数字。

result

Array of EnvironmentHostInfo objects

参数解释

环境下主机信息列表。

取值范围

不涉及。

表5 EnvironmentHostInfo

参数

参数类型

描述

host_id

String

参数解释

主机ID。

取值范围

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

ip

String

参数解释

主机IP,如:161.17.101.12。

取值范围

不涉及。

port

Integer

参数解释

SSH端口,如:22。

取值范围

不涉及。

permission

EnvironmentHostPermission object

参数解释

环境权限详情信息。

取值范围

不涉及。

group_id

String

参数解释

主机集群ID。

取值范围

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

host_name

String

参数解释

主机名。

取值范围

不涉及。

as_proxy

Boolean

参数解释

是否为代理机。

取值范围

  • true:代理机。

  • false:不是代理机。

proxy_host_id

String

参数解释

代理机ID。

取值范围

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

proxy_host_name

String

参数解释

代理机名称。

取值范围

不涉及。

owner_id

String

参数解释

主机所属人ID。

取值范围

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

owner_name

String

参数解释

主机所属人名称。

取值范围

不涉及。

connection_status

String

参数解释

连通性状态。

取值范围

不涉及。

lastest_connection_time

String

参数解释

上次连通时间态。

取值范围

不涉及。

connection_result

String

参数解释

连通性验证结果。

取值范围

不涉及。

nick_name

String

参数解释

创建人昵称。

取值范围

不涉及。

表6 EnvironmentHostPermission

参数

参数类型

描述

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/e1d7b7388b4641e2a027f5673fd6093b/environments/82c4eb8c522d42969a3da30123e1ecba/hosts?page_index=1&page_size=10&key_field=

响应示例

状态码:200

OK 请求响应成功

{
  "status" : "success",
  "result" : [ {
    "ip" : "100.85.172.31",
    "port" : 22,
    "permission" : {
      "can_view" : true,
      "can_edit" : true,
      "can_delete" : true,
      "can_deploy" : true,
      "can_manage" : true
    },
    "host_id" : "13c208e61c9541ab9895f450fd1cbf7c",
    "host_name" : "test",
    "as_proxy" : false,
    "group_id" : "2a8c2da888c04a5eaff10d0787c90ea4",
    "proxy_host_id" : "",
    "proxy_host_name" : null,
    "owner_id" : "6baa7454109d47c192f22078fe6cda20",
    "owner_name" : "devcloud_devcloud_l00490255_01",
    "nick_name" : "devcloud_devcloud_l00490255_01",
    "connection_status" : "failed",
    "connection_result" : "连接失败",
    "lastest_connection_time" : "2024-05-31 14:47:52"
  } ],
  "total" : 1
}

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 ListEnvironmentHostsSolution {

    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();
        ListEnvironmentHostsRequest request = new ListEnvironmentHostsRequest();
        request.withApplicationId("{application_id}");
        request.withEnvironmentId("{environment_id}");
        try {
            ListEnvironmentHostsResponse response = client.listEnvironmentHosts(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 = ListEnvironmentHostsRequest()
        request.application_id = "{application_id}"
        request.environment_id = "{environment_id}"
        response = client.list_environment_hosts(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.ListEnvironmentHostsRequest{}
	request.ApplicationId = "{application_id}"
	request.EnvironmentId = "{environment_id}"
	response, err := client.ListEnvironmentHosts(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

OK 请求响应成功

错误码

请参见错误码

相关文档