Help Center/ CodeArts Build/ API Reference/ APIs/ Build Task Management/ Querying the Build Tasks in the Recycle Bin
Updated on 2025-08-21 GMT+08:00

Querying the Build Tasks in the Recycle Bin

Function

This API is used to query the build tasks in the recycle bin.

Calling Method

For details, see Calling APIs.

URI

GET /v1/job/recycling-jobs

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

page_size

No

Integer

Definition

Number of items displayed on each page.

Constraints

The value is a positive integer.

Range

The value of page_size is no more than 100.

page_no

No

Integer

Definition

The index of the page to start the query from.

Constraints

The value is a positive integer.

Range

The value of page_no is at least 1.

search

No

String

Definition

The task name as the search query.

Range

N/A.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. (The value of the X-Subject-Token response header is the user token.) It is obtained by calling the IAM API. For details, see Obtaining an IAM User Token.

Constraints

Global tenant tokens are not supported. Use a region-level token whose scope is project.

Range

N/A.

Default Value

N/A.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

success

Boolean

Definition

Status.

Range

N/A.

message

String

Definition

Message.

Range

N/A.

err_code

String

Definition

Error code.

Range

N/A.

result

result object

Definition

Data returned after the API is successfully called.

Range

N/A.

status

String

Definition

API response status.

Range

success: The API call is successful.

fail: The API call failed.

Table 4 result

Parameter

Type

Description

keep_time

Integer

Definition

Task retention period.

Range

N/A.

total

Integer

Definition

Total number.

Range

1-2147483647

job_list

Array of RecyclingJob objects

Definition

Task list.

Range

N/A.

Table 5 RecyclingJob

Parameter

Type

Description

job_id

String

Definition

Task ID.

Range

N/A.

job_name

String

Definition

Task name.

Range

N/A.

project_id

String

Definition

CodeArts project ID. ID of the project to which the build task belongs.

Range

N/A.

creator_name

String

Definition

Creator.

Range

N/A.

creator_id

String

Definition

Creator ID.

Range

N/A.

create_time

String

Definition

Creation time.

Range

N/A.

delete_time

String

Definition

Deletion time.

Range

N/A.

create_time_stamp

String

Definition

Creation timestamp.

Range

N/A.

delete_time_stamp

String

Definition

Deletion timestamp.

Range

N/A.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

GET https://{endpoint}/v1/job/recycling-jobs

{
  "job_ids" : [ "f9d6c8466d614a9788e9a0acf6c15f46" ]
}

Example Responses

Status code: 200

OK

{
  "result" : {
    "keep_time" : 29,
    "total" : 1,
    "job_list" : [ {
      "job_id" : "c798139500d2456d82d95d108f182b5a",
      "job_name" : "testJobName",
      "project_id" : "b4d3971c3988463b865f6f920846149e",
      "creator_name" : "testUser",
      "creator_id" : "ae22fd035f354cfa8d82a3f1c8940446",
      "create_time" : "2024-09-20 14:38:49",
      "delete_time" : "2024-09-23 17:40:55",
      "create_time_stamp" : "1726814329",
      "delete_time_stamp" : "1727084455"
    } ]
  },
  "error" : null,
  "status" : "success"
}

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.codeartsbuild.v3.region.CodeArtsBuildRegion;
import com.huaweicloud.sdk.codeartsbuild.v3.*;
import com.huaweicloud.sdk.codeartsbuild.v3.model.*;


public class ListRecyclingJobSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        CodeArtsBuildClient client = CodeArtsBuildClient.newBuilder()
                .withCredential(auth)
                .withRegion(CodeArtsBuildRegion.valueOf("<YOUR REGION>"))
                .build();
        ListRecyclingJobRequest request = new ListRecyclingJobRequest();
        try {
            ListRecyclingJobResponse response = client.listRecyclingJob(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcodeartsbuild.v3.region.codeartsbuild_region import CodeArtsBuildRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcodeartsbuild.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = CodeArtsBuildClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CodeArtsBuildRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListRecyclingJobRequest()
        response = client.list_recycling_job(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    codeartsbuild "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsbuild/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsbuild/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsbuild/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := codeartsbuild.NewCodeArtsBuildClient(
        codeartsbuild.CodeArtsBuildClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListRecyclingJobRequest{}
	response, err := client.ListRecyclingJob(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.