Listing Image Retention Policies
Function
This API is used to list the image retention policies.
Constraints
None.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/instances/{instance_id}/retention/policies
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 |
---|---|---|---|
name |
No |
String |
Name of an image retention policy. |
namespace_id |
No |
Integer |
Namespace ID. |
offset |
No |
Integer |
Start index. The default value is 0. Note: The offset and limit parameters must be used together. The offset value must be 0 or a multiple of the limit value. |
limit |
No |
Integer |
Number of returned records. The default value is 10, and the maximum value is 100. Note: The offset and limit parameters must be used together. The offset value must be 0 or a multiple of the limit value. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total |
Integer |
Total number of policies. |
retentions |
Array of ImageRetention objects |
Image retention policy details. |
Parameter |
Type |
Description |
---|---|---|
id |
Integer |
ID of an image retention policy. |
algorithm |
String |
Algorithm. |
rules |
Array of RetentionRuleResponseBody objects |
Matching rule. |
trigger |
TriggerConfig object |
Triggering mode. |
enabled |
Boolean |
Whether to enable a policy. |
name |
String |
Policy name. |
namespace_id |
Integer |
Namespace ID. |
namespace_name |
String |
Namespace name. |
Parameter |
Type |
Description |
---|---|---|
id |
Integer |
ID of an image retention policy. |
priority |
Integer |
Reserved field. Currently, 0 is the only value. |
disabled |
Boolean |
Whether to disable a policy. |
action |
String |
Reserved field. Currently, retain is the only value. |
template |
String |
Policy template type. The value can be latestPulledN, latestPushedK, nDaysSinceLastPush, or nDaysSinceLastPull. |
params |
Map<String,Object> |
Retention parameters, which are used with template. For details, see the example request. |
tag_selectors |
Array of RetentionSelector objects |
Artifact tag selector. Currently, the value length must be 1. |
scope_selectors |
Map<String,Array<RetentionSelector>> |
Artifact repository selector. Currently, only repository is supported, and the value length must be 1. |
repo_scope_mode |
String |
Repository selection method. This field is used in the frontend. The value can be regular or selection. |
Parameter |
Type |
Description |
---|---|---|
kind |
String |
Matching type. Currently, doublestar is the only value. |
decoration |
String |
Selector matching type. The value is repoMatches for the artifact repository selector. For the artifact tag selector, the value can be matches or excludes. |
pattern |
String |
Selector matching pattern. The maximum length is 512 characters. The regular expression can be nginx-* or {repo1, repo2}. *: matches any field that does not contain a slash (/). **: matches any field that contains a slash (/). ?: matches any single character except a slash (/). {option 1, option 2, ...}: matches any of the options. |
extras |
String |
Reserved field. |
Parameter |
Type |
Description |
---|---|---|
type |
String |
Trigger type. For image signing and retention policies, the options are manual and scheduled (scheduled + manual). For image replication policies, the options are manual, scheduled (scheduled + manual), and event_based (event-triggered + manual). |
trigger_settings |
TriggerSetting object |
Trigger settings. This parameter is required only when type is set to scheduled. |
Parameter |
Type |
Description |
---|---|---|
cron |
String |
Cron settings, in the format of '* * * * * *'. cron is based on the UTC time. |
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}/retention/policies
Example Responses
Status code: 200
The list of image retention policies is queried successfully.
{ "total" : 3, "retentions" : [ { "id" : 34, "algorithm" : "or", "rules" : [ { "id" : 0, "priority" : 0, "disabled" : false, "action" : "retain", "template" : "latestPulledN", "repo_scope_mode" : "regular", "params" : { "latestPulledN" : 111 }, "tag_selectors" : [ { "kind" : "doublestar", "decoration" : "matches", "pattern" : "abc", "extras" : "" } ], "scope_selectors" : { "repository" : [ { "kind" : "doublestar", "decoration" : "repoMatches", "pattern" : "abc", "extras" : "" } ] } } ], "trigger" : { "type" : "scheduled", "trigger_settings" : { "cron" : "0 19 14 * * ?" } }, "enabled" : true, "name" : "abc", "namespace_id" : 51, "namespace_name" : "abc" } ] }
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 ListInstanceRetentionPoliciesSolution { 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(); ListInstanceRetentionPoliciesRequest request = new ListInstanceRetentionPoliciesRequest(); request.withInstanceId("{instance_id}"); try { ListInstanceRetentionPoliciesResponse response = client.listInstanceRetentionPolicies(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 = ListInstanceRetentionPoliciesRequest() request.instance_id = "{instance_id}" response = client.list_instance_retention_policies(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 |
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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := swr.NewSwrClient( swr.SwrClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListInstanceRetentionPoliciesRequest{} request.InstanceId = "{instance_id}" response, err := client.ListInstanceRetentionPolicies(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 image retention policies is queried successfully. |
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