查询daemonsets基本信息列表 - ListK8sDaemonSets
功能介绍
查询daemonsets基本信息列表。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/kubernetes/daemonsets
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0,表示默认企业项目(default)。 |
|
offset |
否 |
Integer |
参数解释: 偏移量:指定返回记录的开始位置 约束限制: 不涉及 取值范围: 最小值0,最大值2000000 默认取值: 默认为0 |
|
daemonset_name |
否 |
String |
参数解释: daemonset名称,用作查询参数。 约束限制: 不涉及 取值范围: 字符长度0-256位 默认取值: 无 |
|
namespace_name |
否 |
String |
参数解释: 命名空间名称,用作查询参数。 约束限制: 不涉及 取值范围: 字符长度0-256位 默认取值: 无 |
|
cluster_name |
否 |
String |
参数解释: 所属集群名称,用作查询参数。 约束限制: 不涉及 取值范围: 字符长度0-256位 默认取值: 无 |
|
limit |
是 |
Integer |
参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 取值10-200 默认取值: 10 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Integer |
daemonset总量 |
|
data_list |
Array of DaemonSetInfo objects |
daemonset基本信息列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
参数解释: daemonset名称。 取值范围: 字符长度0-256位 |
|
namespace_name |
String |
参数解释: 命名空间名称。 取值范围: 字符长度0-256位 |
|
cluster_id |
String |
参数解释: 集群的唯一标识ID,用于唯一确定DaemonSet所属的集群实例。 取值范围: 符合标准UUID格式,字符串长度36位 |
|
cluster_type |
String |
参数解释: DaemonSet所属集群的部署类型,用于区分不同云厂商或部署模式的集群。 取值范围: k8s(原生集群)、cce(CCE集群)、ali(阿里云集群)、tencent(腾讯云集群)、azure(微软云集群)、aws(亚马逊集群)、self_built_hw(华为云自建集群)、self_built_idc(IDC自建集群) |
|
cluster_name |
String |
参数解释: 集群名称。 取值范围: 字符串长度0-256 |
|
status |
String |
参数解释: DaemonSet的运行状态,用于标识当前实例的运行健康度; 取值范围: Running(正常运行)、Failed(存在异常) |
|
pods_num |
Integer |
参数解释: 当前DaemonSet对应的Pod实例总数量; 取值范围: 非负整数,单位为个,最小值0,无上限(取决于集群资源) |
|
image_name |
String |
参数解释: DaemonSet实例所使用的容器镜像的完整名称,包含镜像仓库、镜像名及标签; 取值范围: 符合容器镜像命名规范,字符长度1 - 256位 |
|
match_labels |
Array of LabelInfo objects |
参数解释: 用于匹配Pod的标签集合,K8s通过该标签关联DaemonSet与对应Pod; 取值范围: 数组元素数量≥0,每个元素的key为标签名称,val为标签值,key和val字符长度均为1 - 63位 |
|
create_time |
Long |
参数解释: DaemonSet资源的创建时间; 取值范围: 以毫秒级时间戳格式返回,取值为非负长整数,对应UTC时间1970 - 01 - 01起的毫秒数 |
请求示例
查询daemonsets基本信息列表
GET https://{endpoint}/v5/{project_id}/kubernetes/daemonsets?offset=0&limit=200&enterprise_project_id=all_granted_eps
响应示例
状态码:200
请求已成功
{
"total_num" : 1,
"data_list" : [ {
"name" : "cceaddon-npd",
"namespace_name" : "kube-system",
"pods_num" : 7,
"status" : "Running",
"create_time" : 1720765124000,
"cluster_name" : "glz-2451",
"cluster_id" : "a03efb0c-xxxx-xxxx-xxxx-0255ac100b0b",
"cluster_type" : "cce",
"image_name" : "base-node-problem-detector:1.19.8",
"match_labels" : [ {
"key" : "app.kubernetes.io/name",
"val" : "npd"
}, {
"key" : "app.kubernetes.io/instance",
"val" : "cceaddon-npd"
} ]
} ]
}
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 ListK8sDaemonSetsSolution { 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(); ListK8sDaemonSetsRequest request = new ListK8sDaemonSetsRequest(); try { ListK8sDaemonSetsResponse response = client.listK8sDaemonSets(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 = ListK8sDaemonSetsRequest() response = client.list_k8s_daemon_sets(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.ListK8sDaemonSetsRequest{} response, err := client.ListK8sDaemonSets(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。