All Products
Search

This Product

    Container Registry:GetArtifactSubscriptionRule

    Document Center

    Container Registry:GetArtifactSubscriptionRule

    Last Updated:Sep 25, 2026

    Queries 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:GetArtifactSubscriptionRule

    get

    *Instance

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

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The instance ID.

    cri-c0o11woew0k****

    RuleId

    string

    Yes

    The rule ID.

    crasr-mdbpung4i1rm****

    Response elements

    Element

    Type

    Description

    Example

    object

    IsSuccess

    boolean

    Indicates whether the API call is successful. Valid values:

    • true: The API call is successful.

    • false: The API call failed.

    true
    InstanceId

    string

    The instance ID.

    cri-hpdfkc6utbaq****

    RuleId

    string

    The rule ID.

    crasr-mdbpung4i1rm****

    RequestId

    string

    The request ID.

    D4978DCC-ECBD-40B0-A714-EE6959B22C77
    Code

    string

    The return code.

    success
    SourceProvider

    string

    The source of the artifact.

    Valid values:

    • DOCKER_HUB :

      Docker Hub

    • GCR :

      GCR

    • QUAY :

      Quay.io

    DOCKER_HUB
    SourceNamespaceName

    string

    The source namespace.

    library
    SourceRepoName

    string

    The source repository.

    nginx
    NamespaceName

    string

    The ACR namespace.

    test-ns

    RepoName

    string

    The ACR repository.

    test-repo

    TagRegexp

    string

    The image version in the source repository to subscribe to. Regular expressions are supported.

    release-v.*
    TagCount

    integer

    The number of subscribed images.

    1
    Override

    boolean

    Indicates whether image overwriting is enabled.

    true
    Accelerate

    boolean

    Indicates whether the accelerated link is enabled. The subscription acceleration feature is in public preview. Based on scheduling policies and network link optimization, this feature can improve the image subscription speed.

    true
    CreateTime

    integer

    The creation time. The value is a UNIX timestamp in milliseconds.

    1570759546000
    ModifiedTime

    integer

    The modification time. The value is a UNIX timestamp in milliseconds.

    1638259914000
    Platform

    array

    The operating system and architecture. If the source repository contains multi-architecture images, only images of the specified operating system and architecture are subscribed to the destination repository of the Enterprise instance.

    string

    The operating system and architecture.

    Valid values:

    • linux/arm :

      linux/arm

    • windows/x86 :

      windows/x86

    • */* :

      All platforms.

    • linux/arm64 :

      linux/arm64

    • windows/x86-64 :

      windows/x86-64

    • linux/amd64 :

      linux/amd64

    linux/amd64
    SourceDomain

    string

    Examples

    Success response

    JSON format

    {
  "IsSuccess": true,
  "InstanceId": "cri-hpdfkc6utbaq****\n",
  "RuleId": "crasr-mdbpung4i1rm****\n",
  "RequestId": "D4978DCC-ECBD-40B0-A714-EE6959B22C77",
  "Code": "success",
  "SourceProvider": "DOCKER_HUB",
  "SourceNamespaceName": "library",
  "SourceRepoName": "nginx",
  "NamespaceName": "test-ns\n",
  "RepoName": "test-repo\n",
  "TagRegexp": "release-v.*",
  "TagCount": 1,
  "Override": true,
  "Accelerate": true,
  "CreateTime": 1570759546000,
  "ModifiedTime": 1638259914000,
  "Platform": [
    "linux/amd64"
  ],
  "SourceDomain": ""
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.