文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 容器安装与配置/ 获取集群daemonset列表 - ListAgentDaemonsetInfo
更新时间:2025-12-26 GMT+08:00
分享

获取集群daemonset列表 - ListAgentDaemonsetInfo

功能介绍

获取集群daemonset列表。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/container/kubernetes/clusters/daemonsets

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0,表示默认企业项目(default)。

type

String

参数解释

集群类型

约束限制

不涉及

取值范围

  • cce:CCE集群

  • ali:阿里云集群

  • tencent:腾讯云集群

  • azure:微软云集群

  • aws:亚马逊集群

  • self_built_hw:华为云自建集群

  • self_built_idc:IDC自建集群

默认取值

不涉及

show_cluster_log_status

Boolean

参数解释

查询结果是否显示集群日志的接入状态

约束限制

不涉及

取值范围

  • true:是。

  • false:否。

默认取值

false

access_status

Boolean

参数解释

按照集群的接入状态进行查询,true为已接入,false为未接入

约束限制

不涉及

取值范围

  • true:已接入。

  • false:未接入。

默认取值

不涉及

offset

Integer

参数解释:

偏移量:指定返回记录的开始位置

约束限制:

不涉及

取值范围:

最小值0,最大值2000000

默认取值:

默认为0

limit

Integer

参数解释:

每页显示个数

约束限制:

不涉及

取值范围:

取值10-200

默认取值:

10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

region

String

参数解释:

区域ID,用于查询目的区域内的资产。获取方式请参见获取区域ID

约束限制:

不涉及

取值范围:

字符长度1-128位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

data_list

Array of ClusterInfoResponse objects

参数解释:

数据列表

取值范围:

取值0-200

total_num

Integer

参数解释

已接入集群总数

取值范围

取值0-65535

upgradeful_num

Integer

参数解释

待升级集群总数

取值范围

取值0-65535

err_running_num

Integer

参数解释

运行异常集群总数

取值范围

取值0-65535

err_access_num

Integer

参数解释

接入异常集群总数

取值范围

取值0-65535

表5 ClusterInfoResponse

参数

参数类型

描述

latest_version

Boolean

参数解释

是否最新版本

取值范围

  • true:是。

  • false:否。

agent_version

String

参数解释

集群agent版本

取值范围

字符长度0-32位

cluster_name

String

参数解释

集群名称

取值范围

字符长度0-256位

cluster_id

String

参数解释

集群id

取值范围

字符长度1-256位

namespace

String

参数解释

命名空间

取值范围

字符长度1-32位

cluster_type

String

参数解释

集群类型

取值范围

字符长度1-32位

node_num

Integer

参数解释

节点总数

取值范围

取值0-65535

ds_info

ds_info object

daemonset状态

cluster_status

String

参数解释:

集群状态

约束限制:

不涉及

取值范围:

包含如下:

  • Available:可用,表示集群处于正常状态。

  • Unavailable:不可用,表示集群异常,需手动删除或联系管理员删除。

  • ScalingUp:扩容中,表示集群正处于扩容过程中。

  • ScalingDown:缩容中,表示集群正处于缩容过程中。

  • Creating:创建中,表示集群正处于创建过程中。

  • Deleting:删除中,表示集群正处于删除过程中。

  • Upgrading:升级中,表示集群正处于升级过程中。

  • Resizing:规格变更中,表示集群正处于变更规格中。

  • RollingBack:回滚中,表示集群正处于回滚过程中。

  • RollbackFailed:回滚异常,表示集群回滚异常,需联系管理员进行回滚重试。

  • Empty:集群无任何资源。

默认取值:

不涉及

installed_status

String

参数解释:

集群ds安装状态

约束限制:

不涉及

取值范围:

包含如下:

  • installing:安装中。

  • install_success:安装成功。

  • install_failed:安装失败。

  • partially_success:部分安装成功。

  • upgrade_success:升级成功。

  • upgrade_failed:升级失败。

  • upgrading:升级中。

  • none:未安装。

默认取值:

不涉及

access_status

String

参数解释

集群anp接入状态

约束限制

不涉及

取值范围

  • not_connect:未连接。

  • connect_success:连接成功。

  • connect_fail:连接失败。

  • connect_disruption:连接中断。

默认取值

不涉及

combined_status

String

参数解释

集群anp与ds的组合状态

约束限制

不涉及

取值范围

  • accessing:接入中。

  • access_error:接入异常。

  • running:运行中。

  • run_error:运行异常。

  • upgrading:升级中。

  • upgrade_error:升级失败。

默认取值

不涉及

failed_message

String

参数解释

集群插件接入失败的原因

取值范围

字符长度1-256位

cluster_log_status

String

参数解释

集群日志的接入状态

约束限制

不涉及

取值范围

  • success:接入成功。

  • partial_success:部分接入。

默认取值

不涉及

invoked_service

String

参数解释

调用服务,标识cce免费体检报告

约束限制

不涉及

取值范围

  • hss:hss服务。

  • cce:cce服务。

默认取值

不涉及

registry_info

registry_info object

镜像仓信息

表6 ds_info

参数

参数类型

描述

desired_num

Integer

参数解释

目标数量

取值范围

取值0-65535

current_num

Integer

参数解释

当前数量

取值范围

取值0-65535

ready_num

Integer

参数解释

就绪数量

取值范围

取值0-65535

表7 registry_info

参数

参数类型

描述

registry_type

String

参数解释

镜像仓库类型

取值范围

字符长度1-256位

registry_addr

String

参数解释

镜像仓地址

取值范围

字符长度1-256位

registry_username

String

参数解释

镜像仓用户名

取值范围

字符长度1-256位

namespace

String

参数解释

组织

取值范围

字符长度1-256位

请求示例

获取前200条集群daemonset列表

GET https://{endpoint}/v5/{project_id}/container/kubernetes/clusters/daemonsets?offset=0&limit=200&enterprise_project_id=all_granted_eps

响应示例

状态码:200

请求已成功

{
  "data_list" : [ {
    "cluster_name" : "dfx-master",
    "cluster_id" : "05677f29-1ab0-4ea0-91a3-a72cb8bae59c",
    "cluster_type" : "self_built_idc",
    "node_num" : 0,
    "ds_info" : { },
    "cluster_status" : "Available",
    "installed_status" : "none",
    "access_status" : "not_connect",
    "combined_status" : "running"
  }, {
    "cluster_name" : "cce-hss-jwmtest",
    "cluster_id" : "3af2ba4f-1c1d-11ef-935c-0255ac100b0f",
    "cluster_type" : "cce",
    "node_num" : 2,
    "ds_info" : { },
    "cluster_status" : "Available",
    "installed_status" : "none",
    "access_status" : "connect_success",
    "combined_status" : "running"
  } ],
  "total_num" : 2,
  "upgradeful_num" : 0,
  "err_running_num" : 0,
  "err_access_num" : 1
}

SDK代码示例

SDK代码示例如下。

 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
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.hss.v5.region.HssRegion;
import com.huaweicloud.sdk.hss.v5.*;
import com.huaweicloud.sdk.hss.v5.model.*;


public class ListAgentDaemonsetInfoSolution {

    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");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        HssClient client = HssClient.newBuilder()
                .withCredential(auth)
                .withRegion(HssRegion.valueOf("<YOUR REGION>"))
                .build();
        ListAgentDaemonsetInfoRequest request = new ListAgentDaemonsetInfoRequest();
        try {
            ListAgentDaemonsetInfoResponse response = client.listAgentDaemonsetInfo(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());
        }
    }
}
 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 huaweicloudsdkhss.v5.region.hss_region import HssRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkhss.v5 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"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = HssClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(HssRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListAgentDaemonsetInfoRequest()
        response = client.list_agent_daemonset_info(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/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")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := hss.NewHssClient(
        hss.HssClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListAgentDaemonsetInfoRequest{}
	response, err := client.ListAgentDaemonsetInfo(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档