Querying the Basic Job Information List

Function

This API is used to query the basic job information list.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/kubernetes/jobs

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project.
offset	No	Integer	Definition Offset, which specifies the start position of the record to be returned. Constraints N/A Range The value range is 0 to 2,000,000. Default Value The default value is 0.
job_name	No	String	Job name
namespace_name	No	String	Namespace name
cluster_name	No	String	Cluster name
limit	Yes	Integer	Definition Number of records displayed on each page. Constraints N/A Range Value range: 10 to 200 Default Value 10

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Long	Total number of common tasks
last_update_time	Long	Updated
job_info_list	Array of ServerlessJobInfo objects	Basic information list of a common task

**Table 5** ServerlessJobInfo
Parameter	Type	Description
name	String	Job Name
namespace_name	String	Name
cluster_name	String	Cluster.
status	String	Status. It can be: Running: The system is running properly. Failed: An exception occurs.
pods_num	Integer	Number of Instances
image_name	String	Image Name
match_labels	Array of LabelInfo objects	Label
execute_time	Long	Executed
create_time	Long	Created At

**Table 6** LabelInfo
Parameter	Type	Description
key	String	Tag name
val	String	The tag value.

Example Requests

Query the basic job information list.

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

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "last_update_time" : 2025,
  "job_info_list" : [ {
    "cluster_name" : "glz-2451",
    "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",
    "status" : "Running",
    "pods_num" : 6
  } ]
}

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Container Assets

Previous topic: Querying Basic Deployment Information

Next topic: Querying the Basic StatefulSet Information List

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot