Updated on 2025-09-26 GMT+08:00

Creating an Image Tag Immutability Policy

Function

This API is used to create an image tag immutability policy.

Constraints

None.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/instances/{instance_id}/namespaces/{namespace_name}/immutabletagrules

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.

namespace_name

Yes

String

Namespace name.

Request Parameters

Table 2 Request header 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.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

priority

No

Integer

Priority. The default value is 0.

disabled

No

Boolean

Whether an image tag immutability policy is applied. The default value is false.

action

No

String

Reserved field. The value can be set to immutable.

template

No

String

Reserved field. The value can be set to immutable_template.

tag_selectors

Yes

Array of RuleSelector objects

Artifact tag selector. Currently, the value length must be 1.

scope_selectors

Yes

Map<String,Array<RuleSelector>>

Artifact repository selector. Currently, only repository is supported, and the value length must be 1.

Table 4 RuleSelector

Parameter

Mandatory

Type

Description

kind

Yes

String

Matching type. Currently, doublestar is the only value.

decoration

Yes

String

Selector matching type. The value can be repoMatches.

pattern

Yes

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

No

String

Reserved field.

Response Parameters

Status code: 201

Table 5 Response body parameters

Parameter

Type

Description

id

Integer

Policy ID.

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

POST https://{endpoint}/v2/{project_id}/namespaces/{namespace_name}/immutabletagrules

{
  "priority" : 0,
  "disabled" : true,
  "action" : "immutable",
  "template" : "immutable_template",
  "tag_selectors" : [ {
    "kind" : "doublestar",
    "decoration" : "matches",
    "pattern" : "**"
  } ],
  "scope_selectors" : {
    "repository" : [ {
      "kind" : "doublestar",
      "decoration" : "repoMatches",
      "pattern" : "**"
    } ]
  }
}

Example Responses

Status code: 201

The image tag immutability policy is created successfully.

{
  "id" : 34
}

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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
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;
import java.util.Map;
import java.util.HashMap;

public class CreateImmutableRuleSolution {

    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();
        CreateImmutableRuleRequest request = new CreateImmutableRuleRequest();
        request.withInstanceId("{instance_id}");
        request.withNamespaceName("{namespace_name}");
        CreateImmutableRuleBody body = new CreateImmutableRuleBody();
        List<RuleSelector> listScopeSelectorsScopeSelectors = new ArrayList<>();
        listScopeSelectorsScopeSelectors.add(
            new RuleSelector()
                .withKind("doublestar")
                .withDecoration("repoMatches")
                .withPattern("**")
        );
        Map<String, List<RuleSelector>> listbodyScopeSelectors = new HashMap<>();
        listbodyScopeSelectors.put("repository", listScopeSelectorsScopeSelectors);
        List<RuleSelector> listbodyTagSelectors = new ArrayList<>();
        listbodyTagSelectors.add(
            new RuleSelector()
                .withKind("doublestar")
                .withDecoration("matches")
                .withPattern("**")
        );
        body.withScopeSelectors(listbodyScopeSelectors);
        body.withTagSelectors(listbodyTagSelectors);
        body.withTemplate("immutable_template");
        body.withAction("immutable");
        body.withDisabled(true);
        body.withPriority(0);
        request.withBody(body);
        try {
            CreateImmutableRuleResponse response = client.createImmutableRule(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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
# 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 = CreateImmutableRuleRequest()
        request.instance_id = "{instance_id}"
        request.namespace_name = "{namespace_name}"
        listScopeSelectorsScopeSelectors = [
            RuleSelector(
                kind="doublestar",
                decoration="repoMatches",
                pattern="**"
            )
        ]
        listScopeSelectorsbody = {
            "repository": listScopeSelectorsScopeSelectors
        }
        listTagSelectorsbody = [
            RuleSelector(
                kind="doublestar",
                decoration="matches",
                pattern="**"
            )
        ]
        request.body = CreateImmutableRuleBody(
            scope_selectors=listScopeSelectorsbody,
            tag_selectors=listTagSelectorsbody,
            template="immutable_template",
            action="immutable",
            disabled=True,
            priority=0
        )
        response = client.create_immutable_rule(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
65
66
67
68
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.CreateImmutableRuleRequest{}
	request.InstanceId = "{instance_id}"
	request.NamespaceName = "{namespace_name}"
	var listScopeSelectorsScopeSelectors = []model.RuleSelector{
        {
            Kind: "doublestar",
            Decoration: "repoMatches",
            Pattern: "**",
        },
    }
	var listScopeSelectorsbody = map[string][](model.RuleSelector){
        "repository": listScopeSelectorsScopeSelectors,
    }
	var listTagSelectorsbody = []model.RuleSelector{
        {
            Kind: "doublestar",
            Decoration: "matches",
            Pattern: "**",
        },
    }
	templateCreateImmutableRuleBody:= "immutable_template"
	actionCreateImmutableRuleBody:= "immutable"
	disabledCreateImmutableRuleBody:= true
	priorityCreateImmutableRuleBody:= int32(0)
	request.Body = &model.CreateImmutableRuleBody{
		ScopeSelectors: listScopeSelectorsbody,
		TagSelectors: listTagSelectorsbody,
		Template: &templateCreateImmutableRuleBody,
		Action: &actionCreateImmutableRuleBody,
		Disabled: &disabledCreateImmutableRuleBody,
		Priority: &priorityCreateImmutableRuleBody,
	}
	response, err := client.CreateImmutableRule(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

201

The image tag immutability policy is created successfully.

400

Request error.

401

Authentication failed.

403

Access denied.

404

Resource not found.

500

Internal error.

Error Codes

See Error Codes.