查询主机集群列表
功能介绍
按条件查询主机集群列表。该接口于2024年09月30日后不再维护,推荐使用新版查询主机集群列表(ListHostClusters)接口。
调用方法
请参见如何调用API。
URI
GET /v2/host-groups
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
否 |
String |
参数解释: 项目id,获取方式请参见获取项目id。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
region_name |
是 |
String |
参数解释: 区域ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字、中划线、下划线组成,长度不超过255个字符。 默认取值: 不涉及。 |
os |
否 |
String |
参数解释: 主机集群的操作系统类型。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
offset |
否 |
Integer |
参数解释: 分页查询偏移量,表示从此偏移量开始查询。 约束限制: 不涉及。 取值范围: 0-2147483647 默认取值: 0 |
limit |
否 |
Integer |
参数解释: 分页查询每页显示的条目数量。 约束限制: 不涉及。 取值范围: 1-1000 默认取值: 1000 |
name |
否 |
String |
参数解释: 主机集群名称中的关键字。 约束限制: 不涉及。 取值范围: 只能由中文字符、英文字母、数字及"-"、"_"、"."组成,且长度为[3-128]个字符。 默认取值: 不涉及。 |
sort_key |
否 |
String |
参数解释: 查询排序字段。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
sort_dir |
否 |
String |
参数解释: 排序方式。 约束限制: 不涉及。 取值范围:
默认取值: desc |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 字符串,长度不超过20000个字符。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
total |
Integer |
参数解释: 主机集群个数。 取值范围: 0-1000 |
host_groups |
Array of DeploymentGroupDetail objects |
参数解释: 主机集群列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
group_id |
String |
参数解释: 主机集群id。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 |
created_time |
String |
参数解释: 创建时间。时间格式:yyyy-MM-dd HH:mm:ss。 取值范围: 不涉及。 |
updated_time |
String |
参数解释: 更新时间。时间格式:yyyy-MM-dd HH:mm:ss。 取值范围: 不涉及。 |
host_count |
Integer |
参数解释: 集群内主机数量。 取值范围: 0-200 |
project_name |
String |
参数解释: 项目名称。 取值范围: 由中文字符、英文字符、数字组成,且长度为[3-128]个字符。 |
name |
String |
参数解释: 主机集群名称。 取值范围: 只能由中文字符、英文字母、数字及"-"、"_"、"."组成,且长度为[3-128]个字符。 |
region_name |
String |
参数解释: 区域ID。 取值范围: 只能由英文字母、数字、中划线、下划线组成,长度不超过255个字符。 |
project_id |
String |
参数解释: 项目id,获取方式请参见获取项目id。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 |
os |
String |
参数解释: 主机集群的操作系统类型。 取值范围:
|
auto_connection_test_switch |
Integer |
参数解释: 自动测试功能已下架,该字段已失效。 取值范围: 不涉及。 |
slave_cluster_id |
String |
参数解释: 自托管资源池id。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 |
nick_name |
String |
参数解释: 创建者用户昵称。 取值范围: 字符串,长度为[1-30]个字符。 |
created_by |
UserInfo object |
参数解释: 创建者用户信息,包含用户id,用户名等。 |
updated_by |
UserInfo object |
参数解释: 更新者用户信息,包含用户id,用户名等。 |
description |
String |
参数解释: 主机集群描述信息。 取值范围: 字符串,长度为[0-500]个字符。 |
permission |
PermissionGroupDetail object |
参数解释: 当前用户对主机集群的操作权限矩阵。 |
参数 |
参数类型 |
描述 |
---|---|---|
user_id |
String |
参数解释: 用户id。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
user_name |
String |
参数解释: 用户名。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为[1-255]个字符。 默认取值: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
can_view |
Boolean |
参数解释: 是否有查看权限。 取值范围:
|
can_edit |
Boolean |
参数解释: 是否有编辑权限。 取值范围:
|
can_delete |
Boolean |
参数解释: 是否有删除权限。 取值范围:
|
can_add_host |
Boolean |
参数解释: 是否有添加主机权限。 取值范围:
|
can_manage |
Boolean |
参数解释: 是否有管理主机集群权限矩阵的权限。 取值范围:
|
请求示例
https://{endpoint}/v2/host-groups?region_name=region-a&project_id=6039d4480efc4dddb178abff98719913&offset=1&limit=10&sort_key=name&sort_dir=desc
响应示例
状态码:200
OK 请求响应成功
{
"total" : 1,
"host_groups" : [ {
"name" : "testwyk",
"description" : "11122211",
"os" : "linux",
"nick_name" : "AB边账号",
"group_id" : "ab7647b0863c4e969c8949d38d591339",
"region_name" : "region-a",
"project_id" : "6039d4480efc4dddb178abff98719913",
"permission" : {
"can_view" : true,
"can_edit" : true,
"can_delete" : true,
"can_add_host" : true,
"can_manage" : true
},
"created_by" : {
"user_id" : "6baa7454109d47c192f22078fe6cda20",
"user_name" : "devcloud_devcloud_l00490255_01"
},
"updated_by" : {
"user_id" : "6baa7454109d47c192f22078fe6cda20",
"user_name" : "devcloud_devcloud_l00490255_01"
},
"auto_connection_test_switch" : 0,
"slave_cluster_id" : "",
"created_time" : "2021-04-01 17:05:53",
"updated_time" : "2021-04-21 14:29:14",
"host_count" : 1,
"project_name" : null
} ]
}
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 |
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 ListHostGroupsSolution {
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();
ListHostGroupsRequest request = new ListHostGroupsRequest();
try {
ListHostGroupsResponse response = client.listHostGroups(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 |
# 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 = ListHostGroupsRequest()
response = client.list_host_groups(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 |
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.ListHostGroupsRequest{}
response, err := client.ListHostGroups(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK 请求响应成功 |
错误码
请参见错误码。