All Products
Search

This Product

    Container Registry:CreateArtifactSubscriptionRule

    Document Center

    Container Registry:CreateArtifactSubscriptionRule

    Last Updated:Aug 27, 2026

    Creates an artifact subscription rule.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    cr:CreateArtifactSubscriptionRule

    create

    *Instance

    acs:cr:{#regionId}:{#accountId}:instance/{#InstanceId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The instance ID.

    cri-c0o11woew0k****
    SourceProvider

    string

    Yes

    The source of the artifact.

    Valid values:

    • DOCKER_HUB: Docker Hub

    • GCR: GCR

    • QUAY: Quay.io

    Valid values:

    • DOCKER_HUB :

      Docker Hub

    • GCR :

      GCR

    • QUAY :

      Quay.io

    DOCKER_HUB
    SourceNamespaceName

    string

    No

    The source namespace.

    library
    SourceRepoName

    string

    Yes

    The source repository.

    nginx
    NamespaceName

    string

    Yes

    The Container Registry namespace name.

    test-ns
    RepoName

    string

    Yes

    The Container Registry repository name.

    test-repo
    TagRegexp

    string

    Yes

    The image tag to subscribe to. Supports regular expressions.

    release-v.*
    TagCount

    integer

    Yes

    The number of image tags to subscribe to.

    1
    Override

    boolean

    No

    Whether to overwrite existing images in the destination repository.

    true
    Accelerate

    boolean

    No

    Whether to enable subscription acceleration. This feature is in public preview and optimizes scheduling and network links to speed up image synchronization.

    true
    Platform

    array

    Yes

    The OS and architecture platforms to subscribe. For multi-arch source images, only the specified platforms are synchronized to the Enterprise Edition instance.

    string

    No

    The operating system and architecture.

    Valid values:

    • linux/arm: linux/arm

    • windows/x86: windows/x86

    • */*: */*

    • linux/arm64: linux/arm64.

    • windows/x86-64: windows/x86-64.

    • linux/amd64: linux/amd64.

    Valid values:

    • linux/arm :

      linux/arm

    • windows/x86 :

      windows/x86

    • */* :

      /

    • linux/arm64 :

      linux/arm64

    • windows/x86-64 :

      windows/x86-64

    • linux/amd64 :

      linux/amd64

    */*

    Response elements

    Element

    Type

    Description

    Example

    object

    Code

    string

    The return value.

    success
    IsSuccess

    boolean

    Whether the request succeeded. Valid values:

    • true: The request is successful.

    • false: The request fails.

    true
    RequestId

    string

    The request ID.

    02B27D80-FD32-5155-931A-93700779BB9E
    RuleId

    string

    The ID of the artifact subscription rule.

    crasr-lxdfele7dg4****

    Examples

    Success response

    JSON format

    {
  "Code": "success",
  "IsSuccess": true,
  "RequestId": "02B27D80-FD32-5155-931A-93700779BB9E",
  "RuleId": "crasr-lxdfele7dg4****"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    500 SystemError A system error occurred. An unknown error occurred.
    403 NoPrivilege Access is denied for the user. The user is not authorized.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.