Listing Artifact Cleanup Tasks
Function
This API is used to list the artifact cleanup tasks.
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.
URI
GET /v2/{project_id}/instances/{instance_id}/system/gc
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. |
| instance_id | Yes | String | ID of an SWR Enterprise Edition instance. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| marker | No | String | Marker for pagination query. The value is the next_marker value returned in the last API calling. By default, the query starts from the first data record. Parameters marker and limit should always be used together. |
| limit | No | Integer | The number of items. This parameter is used for pagination query. The default value is 10, and the maximum value is 100. |
| status | No | String | Task status. The value can be Success (completed), Stopped (stopped), Running (in progress), Pending (queuing), or Error (failed). |
Request 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. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| page_info | PageInfo object | Pagination information. |
| tasks | Array of GcTask objects | GC task list details. |
| Parameter | Type | Description |
|---|---|---|
| next_marker | String | Start marker for the next pagination query. If this parameter is not returned, the data query is complete. |
| Parameter | Type | Description |
|---|---|---|
| id | Integer | GC task ID. |
| job_name | String | GC task name. |
| job_kind | String | Task type. The value can be MANUAL (manual execution) or SCHEDULE (scheduled execution). |
| job_parameters | JobParameters object | Job parameters of a GC task. |
| job_status | String | GC task status. The value can be Success (completed), Stopped (stopped), Running (in progress), Pending (queuing), or Error (failed). |
| creation_time | String | The time when a GC task was created. |
| update_time | String | Time when a GC task was updated. |
| Parameter | Type | Description |
|---|---|---|
| delete_untagged | Boolean | Whether to delete artifacts without tags. The default value is false, which means that artifacts without tags are not deleted. |
| workers | Integer | The number of workers that concurrently execute artifact cleanup tasks. The value ranges from 1 to 5. |
| dry_run | Boolean | Whether to perform a dry run. The default value is false, which means that a dry run is not performed. |
| purged_blobs | Integer | The number of image layers that have been cleaned up. |
| purged_manifests | Integer | The number of manifests that have been cleaned up. |
| freed_space | Integer | Size of the released image storage space, in bytes. |
Status code: 400
| 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
| 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
| 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
| 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
| 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
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/system/gc Example Responses
Status code: 200
The list of artifact cleanup tasks is queried.
{
"page_info" : {
"next_marker" : "eyJpZCI6MTIzNH0="
},
"tasks" : [ {
"id" : 1001,
"job_name" : "daily-gc-task",
"job_kind" : "SCHEDULE",
"job_parameters" : {
"delete_untagged" : true,
"dry_run" : true,
"workers" : 3
},
"job_status" : "Success",
"creation_time" : "2024-01-20T10:00:00Z",
"update_time" : "2024-01-26T02:30:15Z"
} ]
} 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 | 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 ListGcTasksSolution { 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(); ListGcTasksRequest request = new ListGcTasksRequest(); request.withInstanceId("{instance_id}"); try { ListGcTasksResponse response = client.listGcTasks(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 | # 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 = ListGcTasksRequest() request.instance_id = "{instance_id}" response = client.list_gc_tasks(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 | 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.ListGcTasksRequest{} request.InstanceId = "{instance_id}" response, err := client.ListGcTasks(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 list of artifact cleanup tasks is queried. |
| 400 | Request error. |
| 401 | Authentication failed. |
| 403 | Access denied. |
| 404 | Resource not found. |
| 500 | Internal error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot