Updated on 2026-06-15 GMT+08:00

Configuring an Artifact Cleanup Schedule

Function

This API is used to configure an artifact cleanup schedule.

Constraints

This API is open to whitelisted tenants. To enable it, submit a service ticket.

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

    swr:instance:updateGcSchedule

    Write

    instance *

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId

    -

    -

URI

PUT /v2/{project_id}/instances/{instance_id}/system/gc/schedule

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

instance_id

Yes

String

ID of an SWR Enterprise Edition instance.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

You can obtain it by calling the IAM API for obtaining a user token. The token is the value of X-Subject-Token in the response header.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

schedule

Yes

ScheduleObj object

Scheduling information of a GC task.

parameters

No

GcParameters object

Job parameters of a GC task. When type of the schedule is set to Custom, job parameters need to be transferred.

Table 4 ScheduleObj

Parameter

Mandatory

Type

Description

type

Yes

String

Schedule type. The value can be None or Custom.

Custom indicates that the task is triggered based on the specified cron job. None indicates that the scheduled task is canceled.

cron

No

String

Cron expression, which is a time-based job scheduler. This parameter is mandatory when type is set to Custom.

Table 5 GcParameters

Parameter

Mandatory

Type

Description

delete_untagged

No

Boolean

Whether to delete artifacts without tags. The default value is false, which means that artifacts without tags are not deleted.

workers

Yes

Integer

The number of workers that concurrently execute artifact cleanup tasks. The value ranges from 1 to 5.

dry_run

No

Boolean

Whether to perform a dry run. The default value is false, which means that a dry run is not performed.

Response Parameters

Status code: 200

The artifact cleanup schedule is configured.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Detailed rejection reason after encryption. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Detailed rejection reason after encryption. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Detailed rejection reason after encryption. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Detailed rejection reason after encryption. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Detailed rejection reason after encryption. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/system/gc/schedule

{
  "parameters" : {
    "delete_untagged" : false,
    "workers" : 1
  },
  "schedule" : {
    "type" : "Custom",
    "cron" : "0 0 0 * * *"
  }
}

Example Responses

Status code: 200

The artifact cleanup schedule is configured.

""

SDK Sample Code

The SDK sample code is as follows.

Java

 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
46
47
48
49
50
51
52
53
54
55
56
57
58
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.swr.v2.region.SwrRegion;
import com.huaweicloud.sdk.swr.v2.*;
import com.huaweicloud.sdk.swr.v2.model.*;


public class UpdateGcScheduleSolution {

    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");
        String projectId = "{project_id}";

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

        SwrClient client = SwrClient.newBuilder()
                .withCredential(auth)
                .withRegion(SwrRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateGcScheduleRequest request = new UpdateGcScheduleRequest();
        request.withInstanceId("{instance_id}");
        UpdateScheduleRequestBody body = new UpdateScheduleRequestBody();
        GcParameters parametersbody = new GcParameters();
        parametersbody.withDeleteUntagged(false)
            .withWorkers(1);
        ScheduleObj schedulebody = new ScheduleObj();
        schedulebody.withType(ScheduleObj.TypeEnum.fromValue("Custom"))
            .withCron("0 0 0 * * *");
        body.withParameters(parametersbody);
        body.withSchedule(schedulebody);
        request.withBody(body);
        try {
            UpdateGcScheduleResponse response = client.updateGcSchedule(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());
        }
    }
}

Python

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkswr.v2.region.swr_region import SwrRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkswr.v2 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"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

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

    try:
        request = UpdateGcScheduleRequest()
        request.instance_id = "{instance_id}"
        parametersbody = GcParameters(
            delete_untagged=False,
            workers=1
        )
        schedulebody = ScheduleObj(
            type="Custom",
            cron="0 0 0 * * *"
        )
        request.body = UpdateScheduleRequestBody(
            parameters=parametersbody,
            schedule=schedulebody
        )
        response = client.update_gc_schedule(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

 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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    swr "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/swr/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/swr/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/swr/v2/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")
    projectId := "{project_id}"

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := swr.SwrClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := swr.NewSwrClient(hcClient)

    request := &model.UpdateGcScheduleRequest{}
	request.InstanceId = "{instance_id}"
	deleteUntaggedParameters:= false
	parametersbody := &model.GcParameters{
		DeleteUntagged: &deleteUntaggedParameters,
		Workers: int32(1),
	}
	cronSchedule:= "0 0 0 * * *"
	schedulebody := &model.ScheduleObj{
		Type: model.GetScheduleObjTypeEnum().CUSTOM,
		Cron: &cronSchedule,
	}
	request.Body = &model.UpdateScheduleRequestBody{
		Parameters: parametersbody,
		Schedule: schedulebody,
	}
	response, err := client.UpdateGcSchedule(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More

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

The artifact cleanup schedule is configured.

400

Request error.

401

Authentication failed.

403

Access denied.

404

Resource not found.

500

Internal error.

Error Codes

See Error Codes.