查询主机列表 (推荐)
功能介绍
根据主机集群id查询指定主机集群下的主机列表。
调用方法
请参见如何调用API。
URI
GET /v1/resources/host-groups/{group_id}/hosts
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
group_id |
是 |
String |
参数解释: 主机集群id。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
key_field |
否 |
String |
参数解释: 主机名称或IP中的关键字。 约束限制: 不涉及。 取值范围: 最大长度不超过128个字符。 默认取值: 不涉及。 |
environment_id |
否 |
String |
参数解释: 环境id。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
page_index |
否 |
Integer |
参数解释: 分页查询页码数。 约束限制: 不涉及。 取值范围: 1-2147483647 默认取值: 1 |
page_size |
否 |
Integer |
参数解释: 分页查询每页显示的条目数量。 约束限制: 不涉及。 取值范围: 1-100 默认取值: 10 |
sort_key |
否 |
String |
参数解释: 查询排序字段。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
sort_dir |
否 |
String |
参数解释: 排序方式。 约束限制: 不涉及。 取值范围:
默认取值: desc |
as_proxy |
否 |
Boolean |
参数解释: 是否为代理机。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 字符串,长度不超过20000个字符。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
total |
Integer |
参数解释: 主机数量。 取值范围: 0-200 |
status |
String |
参数解释: 请求成功、失败状态。 取值范围:
|
result |
Array of HostInfo objects |
参数解释: 主机信息列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
uuid |
String |
参数解释: 主机id。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 |
ip |
String |
参数解释: 主机IP。 取值范围: 不涉及。 |
os |
String |
参数解释: 主机集群的操作系统类型。 取值范围:
|
port |
Integer |
参数解释: 端口号。 取值范围: 0-65535。 |
authorization |
HostAuthorizationBody object |
参数解释: 登录主机鉴权,使用密码登录则填写密码即可,使用密钥则填写密钥,二选一即可。 |
permission |
PermissionHostDetailNew object |
参数解释: 当前用户对主机的操作权限矩阵。 |
host_name |
String |
参数解释: 主机名称。 取值范围: 只能由中文字符、英文字母、数字及"-"、"_"、"."组成,且长度为[3-128]个字符。 |
as_proxy |
Boolean |
参数解释: 是否是代理机。 取值范围:
|
group_id |
String |
参数解释: 主机集群id。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 |
proxy_host_id |
String |
参数解释: 代理主机id。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 |
owner_id |
String |
参数解释: 创建者id。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 |
owner_name |
String |
参数解释: 创建者用户名称。 取值范围: 只能由英文字母、数字及_组成,最大长度不超过255字符。 |
proxy_host |
HostInfo object |
参数解释: 代理机信息详情。 |
connection_status |
String |
参数解释: 连通性状态。 取值范围:
|
create_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 |
参数解释: 连通性验证结果。 取值范围: 不涉及。 |
nick_name |
String |
参数解释: 创建者用户昵称。 取值范围: 字符串,长度为[1-30]个字符。 |
import_status |
String |
参数解释: 导入状态。 取值范围:
|
env_count |
Integer |
参数解释: 关联环境数量。 取值范围: 0-200。 |
参数 |
参数类型 |
描述 |
---|---|---|
username |
String |
参数解释: 登录主机用户名。 取值范围: 只能由字母、数字、下划线、中划线、点号、 @ 符号组成,长度[1-31]字符。 |
password |
String |
参数解释: 密码,认证类型为0时,密码必填。 取值范围: 不能包含空格、换行符、回车符、制表符、双引号和单引号,且长度[5-32]个字符。 |
private_key |
String |
参数解释: 密钥,认证类型为1时,密钥必填。 取值范围: 最大长度不超过5000个字符。 |
trusted_type |
Integer |
参数解释: 登录主机时认证类型。 取值范围:
|
参数 |
参数类型 |
描述 |
---|---|---|
can_view |
Boolean |
参数解释: 是否有查看权限。 取值范围:
|
can_edit |
Boolean |
参数解释: 是否有编辑权限。 取值范围:
|
can_delete |
Boolean |
参数解释: 是否有删除的权限。 取值范围:
|
can_add_host |
Boolean |
参数解释: 是否有添加主机权限。 取值范围:
|
can_copy |
Boolean |
参数解释: 是否有复制主机的权限。 取值范围:
|
请求示例
https://{endpoint}/v1/resources/host-groups/317aea99cf2944fcacf88b34ef771843/hosts?page_index=1&page_size=10&sort_key=host_name&sort_dir=asc&as_proxy=false
响应示例
状态码:200
OK 请求响应成功
{
"result" : [ {
"host_name" : "100.101.28.203",
"ip" : "100.101.28.203",
"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
},
"uuid" : "2cc913cc9a494f09b7320801ebacad02",
"group_id" : "ab7647b0863c4e969c8949d38d591339",
"as_proxy" : false,
"proxy_host_id" : "",
"owner_id" : "6baa7454109d47c192f22078fe6cda20",
"owner_name" : "devcloud_devcloud_l00490255_01",
"connection_status" : "success",
"create_time" : "2021-04-15 11:01:51",
"connection_result" : "连接成功",
"lastest_connection_time" : "2021-04-15 11:02:00",
"nick_name" : "AB边账号",
"proxy_host" : null,
"import_status" : null,
"env_count" : 1
} ],
"total" : 1,
"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 |
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 ListNewHostsSolution {
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();
ListNewHostsRequest request = new ListNewHostsRequest();
request.withGroupId("{group_id}");
try {
ListNewHostsResponse response = client.listNewHosts(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 = ListNewHostsRequest()
request.group_id = "{group_id}"
response = client.list_new_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 |
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.ListNewHostsRequest{}
request.GroupId = "{group_id}"
response, err := client.ListNewHosts(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK 请求响应成功 |
错误码
请参见错误码。