文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 容器网络隔离信息/ 查询集群下某一命名空间下的工作负载 - ListWorkLoads
更新时间:2025-10-31 GMT+08:00
分享

查询集群下某一命名空间下的工作负载 - ListWorkLoads

功能介绍

查询集群下某一命名空间下的工作负载

授权信息

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

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

URI

GET /v5/{project_id}/container-network/{cluster_id}/{namespace}/workloads

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

cluster_id

String

集群id

namespace

String

命名空间

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

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

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

约束限制:

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

取值范围:

字符长度1-256位

默认取值:

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

workload_type

String

工作负载类型,包含如下:

  • deployments:无状态负载

  • statefulsets:有状态负载

  • daemonsets:守护进程表

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of Workload objects

工作负载信息

表5 Workload

参数

参数类型

描述

workload_id

String

工作负载ID

workload_name

String

工作负载名称

workload_type

String

工作负载类型,包含如下:

  • deployments:无状态负载

  • statefulsets:有状态负载

  • daemonsets:守护进程表

请求示例

查询集群下某一命名空间下的工作负载

GET https://{endpoint}/v5/{project_id}/container-network/{cluster_id}/{namespace}/workloads?workload_type=deployments&enterprise_project_id=all_granted_eps

响应示例

状态码:200

请求已成功

{
  "workload_id" : "3d30ed8a-5534-4b41-9977-dbd83aa22b34",
  "workload_name" : "nginx",
  "workload_type" : "deployments"
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档