文档首页> 部署 CodeArts Deploy> API参考> API> 主机集群管理> 查询主机集群列表 (推荐)
更新时间:2024-06-27 GMT+08:00
分享

查询主机集群列表 (推荐)

功能介绍

按条件查询主机集群列表。

调用方法

请参见如何调用API

URI

GET /v1/resources/host-groups

表1 Query参数

参数

是否必选

参数类型

描述

project_id

String

项目id

最小长度:32

最大长度:32

name

String

主机集群模糊查询信息

最小长度:1

最大长度:256

os

String

操作系统:windows|linux

枚举值:

  • windows

  • linux

page_index

Integer

页码数

最小值:0

page_size

Integer

每页显示的条目数量,默认为10

最小值:1

最大值:1000

sort_field

String

排序字段:nick_name|name|owner_name|create_time,不传使用默认排序

sort_type

String

排序方式:DESC、ASC,默认为DESC

枚举值:

  • DESC

  • ASC

is_proxy_mode

Integer

是否为代理机

slave_cluster_id

String

自定义资源池id

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:0

最大长度:20000

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

status

String

请求成功失败状态

total

Integer

主机集群个数

最小值:0

最大值:1000

result

Array of HostClusterInfo objects

主机集群详情响应体

数组长度:0 - 1000

表4 HostClusterInfo

参数

参数类型

描述

id

String

主机集群id

最小长度:32

最大长度:32

host_count

Integer

集群内主机数量,一个主机集群内最多可添加200台主机

最小值:0

最大值:200

name

String

主机集群名

project_id

String

项目id,获取方式请参见获取项目id

os

String

操作系统:windows|linux

slave_cluster_id

String

slave集群id,默认为null时使用默认slave集群,用户自定义slave时为slave集群id

created_by

UserInfo object

用户信息

description

String

描述

最小长度:0

最大长度:500

permission

PermissionClusterDetail object

主机集群相关权限详情类

nick_name

String

创建人名称

env_count

Integer

环境数量

表5 UserInfo

参数

参数类型

描述

user_id

String

用户id

user_name

String

用户名

表6 PermissionClusterDetail

参数

参数类型

描述

can_view

Boolean

是否有查看权限

can_edit

Boolean

是否有编辑权限

can_delete

Boolean

是否有删除权限

can_add_host

Boolean

是否有添加主机权限

can_manage

Boolean

是否有编辑主机集群权限矩阵的权限

请求示例

https://{endpoint}/v1/resources/host-groups?project_id=5d091b14d7f54a139db644092fdc415c&page_index=1&page_size=10&sort_field=name&sort_type=ASC

响应示例

状态码: 200

OK 请求响应成功

{
  "status" : "success",
  "total" : 1,
  "result" : [ {
    "name" : "testwyk",
    "description" : "11122211",
    "os" : "linux",
    "nick_name" : "AB边账号",
    "id" : "ab7647b0863c4e969c8949d38d591339",
    "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"
    },
    "env_count" : 1,
    "slave_cluster_id" : ""
  } ]
}

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
54
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 ListHostClustersSolution {

    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();
        ListHostClustersRequest request = new ListHostClustersRequest();
        request.withProjectId("<project_id>");
        request.withName("<name>");
        request.withOs(ListHostClustersRequest.OsEnum.fromValue("<os>"));
        request.withPageIndex(<page_index>);
        request.withPageSize(<page_size>);
        request.withSortField("<sort_field>");
        request.withSortType(ListHostClustersRequest.SortTypeEnum.fromValue("<sort_type>"));
        request.withIsProxyMode(<is_proxy_mode>);
        request.withSlaveClusterId("<slave_cluster_id>");
        try {
            ListHostClustersResponse response = client.listHostClusters(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
38
39
# 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 = ListHostClustersRequest()
        request.project_id = "<project_id>"
        request.name = "<name>"
        request.os = "<os>"
        request.page_index = <page_index>
        request.page_size = <page_size>
        request.sort_field = "<sort_field>"
        request.sort_type = "<sort_type>"
        request.is_proxy_mode = <is_proxy_mode>
        request.slave_cluster_id = "<slave_cluster_id>"
        response = client.list_host_clusters(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
50
51
52
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.ListHostClustersRequest{}
	request.ProjectId = "<project_id>"
	nameRequest:= "<name>"
	request.Name = &nameRequest
	osRequest:= model.GetListHostClustersRequestOsEnum().<OS>
	request.Os = &osRequest
	pageIndexRequest:= int32(<page_index>)
	request.PageIndex = &pageIndexRequest
	pageSizeRequest:= int32(<page_size>)
	request.PageSize = &pageSizeRequest
	sortFieldRequest:= "<sort_field>"
	request.SortField = &sortFieldRequest
	sortTypeRequest:= model.GetListHostClustersRequestSortTypeEnum().<SORT_TYPE>
	request.SortType = &sortTypeRequest
	isProxyModeRequest:= int32(<is_proxy_mode>)
	request.IsProxyMode = &isProxyModeRequest
	slaveClusterIdRequest:= "<slave_cluster_id>"
	request.SlaveClusterId = &slaveClusterIdRequest
	response, err := client.ListHostClusters(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

OK 请求响应成功

错误码

请参见错误码

分享:

    相关文档

    相关产品