查询主机集群列表
功能介绍
按条件查询主机集群列表。该接口于2024年09月30日后不再维护,推荐使用新版查询主机集群列表(ListHostClusters)接口。
调用方法
请参见如何调用API。
URI
GET /v2/host-groups
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
否 |
String |
项目ID,获取方式请参见获取项目ID。 最小长度:32 最大长度:32 |
region_name |
是 |
String |
局点信息 最小长度:1 最大长度:256 |
os |
否 |
String |
操作系统:windows|linux 枚举值:
|
offset |
否 |
Integer |
偏移量,表示从此偏移量开始查询,offset大于等于0 最小值:0 |
limit |
否 |
Integer |
每页显示的条目数量,默认为1000 最小值:1 最大值:1000 |
name |
否 |
String |
主机集群名 最小长度:3 最大长度:128 |
sort_key |
否 |
String |
排序字段:nickName|NAME|OWNER_NAME|CREATE_TIME|name|owner_name|create_time,不传使用默认排序 |
sort_dir |
否 |
String |
排序方式:DESC、ASC,默认为DESC 枚举值:
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 最小长度:0 最大长度:20000 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
total |
Integer |
主机集群个数 最小值:0 最大值:1000 |
host_groups |
Array of DeploymentGroupDetail objects |
主机集群详情响应体 数组长度:0 - 1000 |
参数 |
参数类型 |
描述 |
---|---|---|
group_id |
String |
主机集群id 最小长度:32 最大长度:32 |
created_time |
String |
创建时间 |
updated_time |
String |
修改时间 |
host_count |
Integer |
集群内主机数量,一个主机集群内最多可添加200台主机 最小值:0 最大值:200 |
project_name |
String |
项目名称 最小长度:3 最大长度:128 |
name |
String |
主机集群名 |
region_name |
String |
局点信息 |
project_id |
String |
项目ID,获取方式请参见获取项目ID。 |
os |
String |
操作系统:windows|linux |
auto_connection_test_switch |
Integer |
自动测试功能已下架,该字段已失效 枚举值:
|
slave_cluster_id |
String |
slave集群id,默认为null时使用默认slave集群,用户自定义slave时为slave集群id |
nick_name |
String |
用户昵称 |
created_by |
UserInfo object |
用户信息 |
updated_by |
UserInfo object |
用户信息 |
description |
String |
描述 最小长度:0 最大长度:500 |
permission |
PermissionGroupDetail object |
主机集群相关权限详情类 |
请求示例
https://{endpoint}/v2/host-groups?region_name=cn-north-7&project_id=6039d4480efc4dddb178abff98719913&offset=1&limit=10&sort_key=create_time&sort_dir=DESC
响应示例
状态码: 200
OK 请求响应成功
{ "total" : 1, "host_groups" : [ { "name" : "testwyk", "description" : "11122211", "os" : "linux", "nick_name" : "AB边账号", "group_id" : "ab7647b0863c4e969c8949d38d591339", "region_name" : "cn-north-7", "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 46 47 48 49 50 51 52 53 |
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(); request.withProjectId("<project_id>"); request.withRegionName("<region_name>"); request.withOs(ListHostGroupsRequest.OsEnum.fromValue("<os>")); request.withOffset(<offset>); request.withLimit(<limit>); request.withName("<name>"); request.withSortKey("<sort_key>"); request.withSortDir(ListHostGroupsRequest.SortDirEnum.fromValue("<sort_dir>")); 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 31 32 33 34 35 36 37 |
# coding: utf-8 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 = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("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() request.project_id = "<project_id>" request.region_name = "<region_name>" request.os = "<os>" request.offset = <offset> request.limit = <limit> request.name = "<name>" request.sort_key = "<sort_key>" request.sort_dir = "<sort_dir>" 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 36 37 38 39 40 41 42 43 44 45 46 47 48 49 |
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{} request.ProjectId = "<project_id>" request.RegionName = "<region_name>" osRequest:= model.GetListHostGroupsRequestOsEnum().<OS> request.Os = &osRequest offsetRequest:= int32(<offset>) request.Offset = &offsetRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest nameRequest:= "<name>" request.Name = &nameRequest sortKeyRequest:= "<sort_key>" request.SortKey = &sortKeyRequest sortDirRequest:= model.GetListHostGroupsRequestSortDirEnum().<SORT_DIR> request.SortDir = &sortDirRequest response, err := client.ListHostGroups(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK 请求响应成功 |
错误码
请参见错误码。