Adding an Image Retention Policy
Description
Add an image retention policy.
Constraints
None
API Calling
For details, see Calling APIs.
URI
POST /v2/manage/namespaces/{namespace}/repos/{repository}/retentions
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
namespace |
Yes |
String |
Organization name. Enter 1 to 64 characters, starting with a lowercase letter and ending with a lowercase letter or digit. Only lowercase letters, digits, periods (.), underscores (_), and hyphens (-) are allowed. Periods, underscores, and hyphens cannot be placed next to each other. A maximum of two consecutive underscores are allowed. |
repository |
Yes |
String |
Image repository name. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Content-Type |
Yes |
String |
Message body type (format). The value can be application/json;charset=utf-8 application/json The default value is application/json. |
X-Auth-Token |
Yes |
String |
User token. The token 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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
algorithm |
Yes |
String |
Retention policy matching rule. The value is or. |
rules |
Yes |
Array of Rule objects |
Image retention policy. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
template |
Yes |
String |
Retention policy type. The value can be date_rule and tag_rule. |
params |
Yes |
Object |
If template is set to date_rule, set params to {"days": "xxx"}. If template is set to tag_rule, set params to {"num": "xxx"}. |
tag_selectors |
Yes |
Array of TagSelector objects |
Exception images. |
Response Parameters
Status code: 201
Parameter |
Type |
Description |
---|---|---|
id |
Integer |
Image retention policy ID. |
Example Request
POST https://{endpoint}/v2/manage/namespaces/{namespace}/repos/{repository}/retentions { "algorithm" : "string", "rules" : [ { "params" : { }, "tag_selectors" : [ { "kind" : "string", "pattern" : "string" } ], "template" : "string" } ] }
Example Response
Status code: 201
Creation succeeded.
{ "id" : 34 }
SDK Sample Code
The following are SDK sample code:
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 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.*; import java.util.List; import java.util.ArrayList; public class CreateRetentionSolution { 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); SwrClient client = SwrClient.newBuilder() .withCredential(auth) .withRegion(SwrRegion.valueOf("cn-north-4")) .build(); CreateRetentionRequest request = new CreateRetentionRequest(); CreateRetentionRequestBody body = new CreateRetentionRequestBody(); List<TagSelector> listRulesTagSelectors = new ArrayList<>(); listRulesTagSelectors.add( new TagSelector() .withKind("string") .withPattern("string") ); List<Rule> listbodyRules = new ArrayList<>(); listbodyRules.add( new Rule() .withTemplate(Rule.TemplateEnum.fromValue("string")) .withParams(new Object()) .withTagSelectors(listRulesTagSelectors) ); body.withRules(listbodyRules); body.withAlgorithm("string"); request.withBody(body); try { CreateRetentionResponse response = client.createRetention(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 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
# coding: utf-8 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.getenv("CLOUD_SDK_AK") sk = os.getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = SwrClient.new_builder() \ .with_credentials(credentials) \ .with_region(SwrRegion.value_of("cn-north-4")) \ .build() try: request = CreateRetentionRequest() listTagSelectorsRules = [ TagSelector( kind="string", pattern="string" ) ] listRulesbody = [ Rule( template="string", params={}, tag_selectors=listTagSelectorsRules ) ] request.body = CreateRetentionRequestBody( rules=listRulesbody, algorithm="string" ) response = client.create_retention(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 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := swr.NewSwrClient( swr.SwrClientBuilder(). WithRegion(region.ValueOf("cn-north-4")). WithCredential(auth). Build()) request := &model.CreateRetentionRequest{} var listTagSelectorsRules = []model.TagSelector{ { Kind: "string", Pattern: "string", }, } paramsRules:= make(map[string]string) var paramsRulesInterface interface{} = paramsRules var listRulesbody = []model.Rule{ { Template: model.GetRuleTemplateEnum().STRING, Params: ¶msRulesInterface, TagSelectors: listTagSelectorsRules, }, } request.Body = &model.CreateRetentionRequestBody{ Rules: listRulesbody, Algorithm: "string", } response, err := client.CreateRetention(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code in other programming languages, see the Sample Code tab in the API Explorer.
Status Codes
Status Code |
Description |
---|---|
201 |
Creation succeeded. |
400 |
Request error. |
401 |
Authentication failed. |
404 |
The organization or the repository does not exist. |
500 |
Internal error. |
Error Codes
For details, 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