查询pod基本信息列表 - ListK8sPods
功能介绍
查询pod基本信息列表
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/kubernetes/pods
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
|
limit |
否 |
Integer |
参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 取值10-200 默认取值: 10 |
|
pod_name |
否 |
String |
pod名称 |
|
namespace_name |
否 |
String |
命名空间名称 |
|
cluster_name |
否 |
String |
所属集群名称 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Long |
pod总数 |
|
data_list |
Array of PodBaseInfo objects |
pod列表 |
|
pod_info_list |
Array of ServerlessPodInfo objects |
实例基本信息列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
pod_name |
String |
pod名称 |
|
namespace_name |
String |
命名空间名称 |
|
cluster_name |
String |
所属集群 |
|
node_name |
String |
所属节点名称 |
|
cpu |
String |
CPU使用量 |
|
memory |
String |
内存使用量 |
|
cpu_limit |
String |
cpu限制 |
|
memory_limit |
String |
内存限制 |
|
node_ip |
String |
所属节点IP |
|
pod_ip |
String |
Pod IP |
|
status |
String |
Pod状态，包含以下几种 -Pending：pod已被Kubernetes系统接受，但尚未创建一个或多个容器镜像 -Running：pod已经绑定到一个节点，并且所有的容器都已经创建完毕 -Succeeded：pod中的所有容器都已成功终止，不会重新启动 -Failed：pod中的所有容器都已终止，并且至少有一个容器因故障而终止 -Unknown：由于某种原因无法获取pod的状态，通常是由于与pod的主机通信时出错 |
|
create_time |
Long |
创建时间 |
|
region_id |
String |
regionId |
|
id |
String |
ID |
|
cluster_id |
String |
集群id |
|
cluster_type |
String |
集群类型，包含以下几种：
|
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
pod_name |
String |
实例名称 |
|
namespace_name |
String |
命名空间名称 |
|
cluster_name |
String |
所属集群 |
|
cpu |
String |
CPU使用量 |
|
memory |
String |
内存使用量 |
|
cpu_limit |
String |
cpu限制 |
|
memory_limit |
String |
内存限制 |
|
pod_ip |
String |
实例 IP |
|
protect_status |
String |
参数解释: 防护状态 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
detect_result |
String |
Serverless安全检测结果，包含如下4种。
|
|
status |
String |
Pod状态，包含以下几种 -Pending：pod已被Kubernetes系统接受，但尚未创建一个或多个容器镜像 -Running：pod已经绑定到一个节点，并且所有的容器都已经创建完毕 -Succeeded：pod中的所有容器都已成功终止，不会重新启动 -Failed：pod中的所有容器都已终止，并且至少有一个容器因故障而终止 -Unknown：由于某种原因无法获取pod的状态，通常是由于与pod的主机通信时出错 |
|
create_time |
Long |
创建时间 |
请求示例
查询pod基本信息列表
GET https://{endpoint}/v5/{project_id}/kubernetes/pods?offset=0&limit=200&enterprise_project_id=all_granted_eps
响应示例
状态码：200
请求已成功
{
"total_num" : 107,
"last_update_time" : 1753498970618,
"data_list" : [ {
"id" : "1d72f695-2bce-48b7-8576-c8e427cc08b7",
"pod_name" : "node-problem-controller-667894bc4-nz5xj",
"namespace_name" : "kube-system",
"node_name" : "192.168.0.50",
"node_ip" : "192.168.0.50",
"pod_ip" : "10.0.2.131",
"status" : "Running",
"create_time" : 1753227292000,
"cluster_name" : "hss-baseline-mww",
"cluster_id" : "43411c30-450b-11f0-a624-0255ac1001b7",
"cluster_type" : "cce",
"region_id" : "cn-north-7"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。
