文档首页/ 部署 CodeArts Deploy/ API参考/ API/ 主机管理/ 查询主机详情 (推荐)
更新时间:2025-07-01 GMT+08:00
分享

查询主机详情 (推荐)

功能介绍

根据主机id查询主机详情。

调用方法

请参见如何调用API

URI

GET /v1/resources/host-groups/{group_id}/hosts/{host_id}

表1 路径参数

参数

是否必选

参数类型

描述

group_id

String

参数解释

主机集群id。

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

host_id

String

参数解释

主机id。

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

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

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

status

String

参数解释

请求成功、失败状态。

取值范围

  • success:请求成功。

  • failed:请求失败。

result

HostInfoDetail object

参数解释

主机详情信息。

表4 HostInfoDetail

参数

参数类型

描述

host_id

String

参数解释

主机id。

取值范围

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

ip

String

参数解释

主机IP。

取值范围

不涉及。

os

String

参数解释

主机的操作系统类型。

取值范围

  • windows:windows操作系统类型。

  • linux:linux操作系统类型。

port

Integer

参数解释

端口号。

取值范围

0-65535。

authorization

HostAuthorizationBody object

参数解释

登录主机鉴权,使用密码登录则填写密码即可,使用密钥则填写密钥,二选一即可。

permission

PermissionHostDetailNew object

参数解释

当前用户对主机的操作权限矩阵。

group_id

String

参数解释

主机集群id。

取值范围

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

host_name

String

参数解释

主机名称。

取值范围

只能由中文字符、英文字母、数字及"-"、"_"、"."组成,且长度为[3-128]个字符。

as_proxy

Boolean

参数解释

是否是代理机。

取值范围

  • true:是代理机。

  • false:非代理机。

proxy_host_id

String

参数解释

代理主机id。

取值范围

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

owner_name

String

参数解释

创建者用户名称。

取值范围

只能由英文字母、数字及_组成,最大长度不超过255字符。

proxy_host

HostInfoDetail object

参数解释

代理机信息详情。

connection_status

String

参数解释

连通性状态。

取值范围

  • success:连接成功。

  • failed:连接失败。

create_time

String

参数解释

创建时间,格式为yyyy-MM-dd HH:mm:ss。例如:'2025-04-21 17:05:53'。

取值范围

不涉及。

update_time

String

参数解释

更新时间,格式为yyyy-MM-dd HH:mm:ss。例如:'2025-04-21 17:05:53'。

取值范围

不涉及。

lastest_connection_time

String

参数解释

最后一次主机连通性验证时间,格式为yyyy-MM-dd HH:mm:ss。例如:'2025-04-21 17:05:53'。

取值范围

不涉及。

connection_result

String

参数解释

连通性验证结果。

取值范围

不涉及。

install_icagent

Boolean

参数解释

icagent安装状态。

取值范围

  • true:已安装。

  • false:未安装。

nick_name

String

参数解释

创建者用户昵称。

取值范围

字符串,长度为[1-30]个字符。

表5 HostAuthorizationBody

参数

参数类型

描述

username

String

参数解释

登录主机用户名。

取值范围

只能由字母、数字、下划线、中划线、点号、 @ 符号组成,长度[1-31]字符。

password

String

参数解释

密码,认证类型为0时,密码必填。

取值范围

不能包含空格、换行符、回车符、制表符、双引号和单引号,且长度[5-32]个字符。

private_key

String

参数解释

密钥,认证类型为1时,密钥必填。

取值范围

最大长度不超过5000个字符。

trusted_type

Integer

参数解释

登录主机时认证类型。

取值范围

  • 0:密码认证。

  • 1:密钥认证。

表6 PermissionHostDetailNew

参数

参数类型

描述

can_view

Boolean

参数解释

是否有查看权限。

取值范围

  • true: 有权限

  • false: 无权限

can_edit

Boolean

参数解释

是否有编辑权限。

取值范围

  • true: 有权限

  • false: 无权限

can_delete

Boolean

参数解释

是否有删除的权限。

取值范围

  • true: 有权限

  • false: 无权限

can_add_host

Boolean

参数解释

是否有添加主机权限。

取值范围

  • true:有添加主机权限。

  • false:无添加主机权限。

can_copy

Boolean

参数解释

是否有复制主机的权限。

取值范围

  • true:有复制主机的权限。

  • false:无复制主机的权限。

请求示例

https://{endpoint}/v1/resources/host-groups/ab7647b0863c4e969c8949d38d591339/hosts/300d6d2e53624d0da08b182099ad10f7

响应示例

状态码:200

OK 请求响应成功

{
  "result" : {
    "host_id" : "300d6d2e53624d0da08b182099ad10f7",
    "ip" : "100.101.28.215",
    "port" : 22,
    "os" : "linux",
    "authorization" : {
      "username" : "root",
      "password" : null,
      "private_key" : null,
      "trusted_type" : 0
    },
    "permission" : {
      "can_view" : true,
      "can_edit" : true,
      "can_delete" : true,
      "can_add_host" : true,
      "can_copy" : true
    },
    "group_id" : "ab7647b0863c4e969c8949d38d591339",
    "host_name" : "100.101.28.215",
    "as_proxy" : false,
    "proxy_host_id" : null,
    "owner_name" : "devcloud_devcloud_l00490255_01",
    "proxy_host" : null,
    "connection_status" : "success",
    "install_icagent" : false,
    "create_time" : "2021-05-13 09:35:41",
    "update_time" : "2021-05-13 09:35:41",
    "connection_result" : "连接成功",
    "lastest_connection_time" : "2021-05-13 09:36:11",
    "nick_name" : "AB边账号"
  },
  "status" : "success"
}

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

    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();
        ShowHostDetailRequest request = new ShowHostDetailRequest();
        request.withGroupId("{group_id}");
        request.withHostId("{host_id}");
        try {
            ShowHostDetailResponse response = client.showHostDetail(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 = ShowHostDetailRequest()
        request.group_id = "{group_id}"
        request.host_id = "{host_id}"
        response = client.show_host_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.ShowHostDetailRequest{}
	request.GroupId = "{group_id}"
	request.HostId = "{host_id}"
	response, err := client.ShowHostDetail(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

OK 请求响应成功

错误码

请参见错误码

相关文档