Obtaining the Job List

Function

This API is used to obtain all jobs in a specified project.

Calling Method

For details, see Calling APIs.

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, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

cce:job:list

List

cluster *

-

-

-

-

cce:ClusterId

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
cce:job:list	List	cluster *	-	-	-
-	cce:ClusterId

URI

GET /api/v2/projects/{project_id}/jobs

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Details: Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI. Constraints: None Options: Project IDs of the account Default value: N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Definition: Type (or format) of the request body. The default value is application/json. Other values of this field will be provided for specific APIs, if any. Constraints: GET requests are not validated. Range: N/A Default Value: N/A
X-Auth-Token	Yes	String	Details: Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see Obtaining a User Token. Constraints: None Options: N/A Default value: N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
[items]	Array of V2Job objects	Definition Job details list. Range N/A

**Table 4** V2Job
Parameter	Type	Description
kind	String	Definition API type. Range N/A
apiVersion	String	Definition API version. Range N/A
metadata	V2JobTypeObject object	Definition Job metadata. Range N/A
spec	V2JobSpec object	Definition Job details. Range N/A
status	V2JobStatus object	Definition Job status. Range N/A

**Table 5** V2JobTypeObject
Parameter	Type	Description
uid	String	Definition Job UUID. Range N/A
creationTimestamp	String	Definition Job creation time. Range N/A
updateTimestamp	String	Definition Last update time of a job. Range N/A

**Table 6** V2JobSpec
Parameter	Type	Description
type	String	Definition Job type. Range N/A
clusteruid	String	Definition Cluster ID. Range N/A
resourceid	String	Definition Resource ID. Range N/A
resourcename	String	Definition Resource name. Range N/A
extendparam	Map<String,String>	Definition Job scale-out parameters. Range N/A
subjobs	Array of V2Job objects	Definition Subjob details list. Range N/A

**Table 7** V2JobStatus
Parameter	Type	Description
status	String	Definition Job status. Range Initializing: The job is not executed. Running: The job is being executed. Failed: The job fails to be executed. Success: The job has been executed.
reason	String	Definition Cause of a job execution failure. Range N/A
completionTime	String	Definition Job completion time. Range N/A

Example Requests

None

Example Responses

Status code: 200

[ {
  "kind" : "Job",
  "apiVersion" : "v2",
  "metadata" : {
    "uid" : "e43c6f3b-87e6-11f0-be88-0255ac10003f",
    "creationTimestamp" : "2025-09-02 10:23:38.987955 +0000 UTC",
    "updateTimestamp" : "2025-09-02 11:26:03.218087 +0000 UTC"
  },
  "spec" : {
    "type" : "ScaleupCluster",
    "clusteruid" : "7ec8b73d-83db-11f0-8baa-0255ac10003e",
    "resourceid" : "3b4410fa-87e6-11f0-be88-0255ac10003f",
    "resourcename" : "node-iv28j9",
    "extendparam" : {
      "claimrollback" : "true",
      "node.zone" : "cn-north-7c",
      "nodepooluid" : "",
      "orderID" : "CS25090218238EI5V",
      "v3-scaleup" : "true"
    }
  },
  "status" : {
    "status" : "Failed",
    "reason" : "Something bad happened at server, recycle resource",
    "completionTime" : "2025-09-02 11:26:03.218087 +0000 UTC"
  }
} ]

Status Codes

Status Code	Description
200	Definition Job details list. Constraints N/A Range N/A Default Value N/A

Error Codes

See Error Codes.

Parent Topic: Job Management

Previous topic: Job Management

Next topic: Obtaining Job Details