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

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

功能介绍

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

调用方法

请参见如何调用API

URI

GET /v1/resources/host-groups

表1 Query参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

name

String

参数解释

主机集群名称中的关键字。

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

os

String

参数解释

主机集群的操作系统类型。

约束限制

不涉及。

取值范围

  • windows:windows操作系统类型。

  • linux:linux操作系统类型。

默认取值

不涉及。

page_index

Integer

参数解释

分页查询页码数。

约束限制

不涉及。

取值范围

1-2147483647

默认取值

1

page_size

Integer

参数解释

分页查询每页显示的条目数量。

约束限制

不涉及。

取值范围

1-1000

默认取值

1000

sort_field

String

参数解释

查询排序字段。

约束限制

不涉及。

取值范围

  • nick_name:用户昵称。

  • name:主机集群名称。

默认取值

不涉及。

sort_type

String

参数解释

排序方式。

约束限制

不涉及。

取值范围

  • desc:降序排列。

  • asc:升序排列。

默认取值

desc

is_proxy_mode

Integer

参数解释

是否为代理模式主机集群。

约束限制

不涉及。

取值范围

  • 0:非代理模式主机集群。

  • 1:代理模式主机集群。

默认取值

不涉及

slave_cluster_id

String

参数解释

传default查询使用官方资源池主机集群列表,传自托管资源池id查询使用该自托管资源池的主机集群列表。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符,或传default查询使用官方资源池的主机集群列表。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

status

String

参数解释

请求成功、失败状态。

取值范围

  • success:请求成功。

  • failed:请求失败。

total

Integer

参数解释

主机集群个数。

取值范围

0-1000

result

Array of HostClusterInfo objects

参数解释

主机集群列表。

约束限制

主机集群数量不超过1000。

表4 HostClusterInfo

参数

参数类型

描述

id

String

参数解释

主机集群id。

取值范围

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

host_count

Integer

参数解释

集群内主机数量。

取值范围

0-200

name

String

参数解释

主机集群名称。

取值范围

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

project_id

String

参数解释

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

取值范围

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

os

String

参数解释

主机集群的操作系统类型。

取值范围

  • windows:windows操作系统类型。

  • linux:linux操作系统类型。

slave_cluster_id

String

参数解释

自托管资源池id。

取值范围

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

description

String

参数解释

主机集群描述信息。

取值范围

字符串,长度为[0-500]个字符。

permission

PermissionClusterDetail object

参数解释

主机集群权限信息。

约束限制

不涉及。

nick_name

String

参数解释

用户昵称。

取值范围

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

env_count

Integer

参数解释

主机集群关联环境数量。

取值范围

0-200

is_proxy_mode

Integer

参数解释

是否为代理模式主机集群。

约束限制

不涉及。

取值范围

  • 0:非代理模式主机集群。

  • 1:代理模式主机集群。

默认取值

不涉及

表5 PermissionClusterDetail

参数

参数类型

描述

can_view

Boolean

参数解释

是否有查看权限。

取值范围

  • true:有查看权限。

  • false:无查看权限。

can_edit

Boolean

参数解释

是否有编辑权限。

取值范围

  • true:有编辑权限。

  • false:无编辑权限。

can_delete

Boolean

参数解释

是否有删除权限。

取值范围

  • true:有删除权限。

  • false:无删除权限。

can_add_host

Boolean

参数解释

是否有添加主机权限。

取值范围

  • true:有添加主机权限。

  • false:无添加主机权限。

can_manage

Boolean

参数解释

是否有管理主机集群权限矩阵的权限。

取值范围

  • true:有管理主机集群权限矩阵的权限。

  • false:无管理主机集群权限矩阵的权限。

can_copy

Boolean

参数解释

是否有复制主机的权限。

取值范围

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

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

请求示例

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,
      "can_copy" : true
    },
    "host_count" : 1,
    "env_count" : 1,
    "is_proxy_mode" : 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
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();
        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
# 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()
        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
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{}
	response, err := client.ListHostClusters(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

OK 请求响应成功

错误码

请参见错误码