查询jobs基本信息列表 - ListK8sJobs
功能介绍
查询jobs基本信息列表
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/kubernetes/jobs
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
|
job_name |
否 |
String |
job名称 |
|
namespace_name |
否 |
String |
命名空间名称 |
|
cluster_name |
否 |
String |
所属集群名称 |
|
limit |
是 |
Integer |
参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 取值10-200 默认取值: 10 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Long |
普通任务总量 |
|
last_update_time |
Long |
最近更新时间 |
|
job_info_list |
Array of ServerlessJobInfo objects |
普通任务基本信息列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
普通任务名称 |
|
namespace_name |
String |
命名空间名称 |
|
cluster_name |
String |
所属集群 |
|
status |
String |
状态，包含以下几种 -Running：正常运行 -Failed：存在异常 |
|
pods_num |
Integer |
实例个数 |
|
image_name |
String |
镜像名称 |
|
match_labels |
Array of LabelInfo objects |
标签 |
|
execute_time |
Long |
执行时间 |
|
create_time |
Long |
创建时间 |
请求示例
查询jobs基本信息列表
GET https://{endpoint}/v5/{project_id}/kubernetes/jobs?offset=0&limit=200&enterprise_project_id=all_granted_eps
响应示例
状态码：200
请求已成功
{
"total_num" : 1,
"data_list" : [ {
"cluster_id" : "a03efb0c-xxxx-xxxx-xxxx-0255ac100b0b",
"cluster_name" : "glz-2451",
"cluster_type" : "cce",
"create_time" : 1720765124000,
"execute_time" : 1720765124000,
"image_name" : "base-node-problem-detector:1.19.8",
"match_labels" : [ {
"key" : "app.kubernetes.io/name",
"val" : "npd"
} ],
"name" : "cceaddon-npd",
"namespace_name" : "kube-system",
"pods_num" : 6,
"running_jobs_num" : 10,
"schedule" : "30 00 */1 * *",
"status" : "Running"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。
