Listing Image Signing Policies_Image Signing Management_API_API Reference (Enterprise Edition)_SoftWare Repository for Container-Huawei Cloud

Function

This API is used to list the image signing policies.

Constraints

None.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/instances/{instance_id}/signature/policies

**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.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
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

**Table 3** 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.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
policies	Array of SignPolicyDetail objects	List of image signing policies.
total	Integer	Total number of image signing policies.

**Table 5** SignPolicyDetail
Parameter	Type	Description
id	Integer	ID of an image signing policy.
name	String	Name of an image signing policy.
description	String	Description of an image signing policy.
namespace_id	Integer	Namespace ID.
namespace_name	String	Namespace name.
trigger	TriggerConfig object	Triggering mode.
creator	String	Creator.
enabled	Boolean	Whether to enable an image signing policy.
scope_rules	Array of SignScopeRule objects	Application scope.
created_at	String	Creation time.
updated_at	String	Update time.
signature_algorithm	String	Signing algorithm. The key algorithm EC_P256 of KMS corresponds to ECDSA_SHA_256, EC_P384 corresponds to ECDSA_SHA_384, and SM2 corresponds to SM2DSA_SM3.
signature_key	String	Key ID of the signing algorithm.
signature_method	String	Image signing method.

**Table 6** TriggerConfig
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.

**Table 7** TriggerSetting
Parameter	Type	Description
cron	String	Cron settings, in the format of '* * * * * *'. cron is based on the UTC time.

**Table 8** SignScopeRule
Parameter	Type	Description
tag_selectors	Array of SignRuleSelector objects	Artifact tag selector. Currently, the value length must be 1.
scope_selectors	Map<String,Array<SignRuleSelector>>	Artifact repository selector. Currently, only repository is supported, and the value length must be 1.
repo_scope_mode	String	Repository selection method. The value can be regular or selection. regular is required for frontend display and optional for API calling.

**Table 9** SignRuleSelector
Parameter	Type	Description
kind	String	Matching type. Currently, doublestar is the only value.
decoration	String	Selector matching type. The value can be repoMatches.
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. In an image signing policy, if an artifact without a tag is signed, {"untagged":true} is transferred.

Status code: 400

**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.

Status code: 401

**Table 11** 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 12** 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 13** 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 14** 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

Creating an image signing policy (untagged images included)

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/signature/policies

{
  "name" : "aaa",
  "enabled" : true,
  "signature_method" : "KMS",
  "signature_algorithm" : "ECDSA_SHA_256",
  "signature_key" : "key-123456",
  "trigger" : {
    "type" : "manual"
  },
  "scope_rules" : [ {
    "tag_selectors" : [ {
      "kind" : "doublestar",
      "decoration" : "matches",
      "pattern" : "**",
      "extras" : "{\"untagged\":true}"
    } ],
    "scope_selectors" : {
      "repository" : [ {
        "kind" : "doublestar",
        "decoration" : "repoMatches",
        "pattern" : "{repo}"
      } ]
    },
    "repo_scope_mode" : "selection"
  } ]
}

Creating an image signing policy (untagged images excluded)

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/signature/policies

{
  "name" : "aaa",
  "enabled" : true,
  "signature_method" : "KMS",
  "signature_algorithm" : "ECDSA_SHA_256",
  "signature_key" : "key-123456",
  "trigger" : {
    "type" : "manual"
  },
  "scope_rules" : [ {
    "tag_selectors" : [ {
      "kind" : "doublestar",
      "decoration" : "matches",
      "pattern" : "**",
      "extras" : ""
    } ],
    "scope_selectors" : {
      "repository" : [ {
        "kind" : "doublestar",
        "decoration" : "repoMatches",
        "pattern" : "{repo}"
      } ]
    },
    "repo_scope_mode" : "selection"
  } ]
}

Example Responses

Status code: 200

The list of image signing policies is queried successfully.

{
  "total" : 2,
  "policies" : [ {
    "id" : 1,
    "name" : "test-abc",
    "description" : "",
    "created_at" : "2020-11-19T02:58:54.809Z",
    "updated_at" : "2020-11-19T02:58:54.809Z",
    "creator" : "admin",
    "enabled" : true,
    "scope_rules" : [ {
      "scope_selectors" : {
        "repository" : [ {
          "kind" : "doublestar",
          "decoration" : "repoMatches",
          "pattern" : "**"
        } ]
      },
      "tag_selectors" : [ {
        "kind" : "doublestar",
        "decoration" : "matches",
        "pattern" : "**"
      } ]
    } ],
    "namespace_id" : 1,
    "trigger" : {
      "type" : "manual"
    }
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

Java

Creating an image signing policy (untagged images included)

      
       
         
         
           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 ListInstanceSignPoliciesSolution {

    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();
        ListInstanceSignPoliciesRequest request = new ListInstanceSignPoliciesRequest();
        request.withInstanceId("{instance_id}");
        try {
            ListInstanceSignPoliciesResponse response = client.listInstanceSignPolicies(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());
        }
    }
}

          

        

      
     

Creating an image signing policy (untagged images excluded)

      
       
         
         
           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 ListInstanceSignPoliciesSolution {

    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();
        ListInstanceSignPoliciesRequest request = new ListInstanceSignPoliciesRequest();
        request.withInstanceId("{instance_id}");
        try {
            ListInstanceSignPoliciesResponse response = client.listInstanceSignPolicies(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

Creating an image signing policy (untagged images included)

      
       
         
         
           # 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 = ListInstanceSignPoliciesRequest()
        request.instance_id = "{instance_id}"
        response = client.list_instance_sign_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)

          

        

      
     

Creating an image signing policy (untagged images excluded)

      
       
         
         
           # 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 = ListInstanceSignPoliciesRequest()
        request.instance_id = "{instance_id}"
        response = client.list_instance_sign_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

Creating an image signing policy (untagged images included)

      
       
         
         
           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.ListInstanceSignPoliciesRequest{}
	request.InstanceId = "{instance_id}"
	response, err := client.ListInstanceSignPolicies(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     

Creating an image signing policy (untagged images excluded)

      
       
         
         
           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.ListInstanceSignPoliciesRequest{}
	request.InstanceId = "{instance_id}"
	response, err := client.ListInstanceSignPolicies(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 signing 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.

Listing Image Signing Policies

Function

Constraints

Calling Method

URI

Request Parameters

Response Parameters

Example Requests

Example Responses

SDK Sample Code

Java

Python

Go

More

Status Codes

Error Codes

Feedback

Was this page helpful?