All Products
Search
Document Center

Container Registry:GetArtifactSubscriptionRule

Last Updated:Dec 16, 2025

Queries the information about an artifact subscription rule.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
cr:GetArtifactSubscriptionRuleget
*Instance
acs:cr:{#regionId}:{#accountId}:instance/{#InstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The instance ID.

cri-c0o11woew0k****
RuleIdstringYes

The rule ID.

crasr-mdbpung4i1rm****

Response parameters

ParameterTypeDescriptionExample
object
IsSuccessboolean

Indicates whether the API request is successful. Valid values:

  • true: The request is successful.
  • false: The request fails.
true
InstanceIdstring

The instance ID.

cri-hpdfkc6utbaq****
RuleIdstring

The rule ID.

crasr-mdbpung4i1rm****
RequestIdstring

The request ID.

D4978DCC-ECBD-40B0-A714-EE6959B22C77
Codestring

The return value.

success
SourceProviderstring

The source of the artifact.

Valid values:

  • DOCKER_HUB: Docker Hub
  • GCR: GCR
  • QUAY: Quay.io
DOCKER_HUB
SourceNamespaceNamestring

The name of the source namespace.

library
SourceRepoNamestring

The source repository.

nginx
NamespaceNamestring

The name of the Container Registry namespace.

test-ns
RepoNamestring

The name of the Container Registry repository.

test-repo
TagRegexpstring

The image tag in the subscription source repository. Regular expressions are supported.

release-v.*
TagCountlong

The number of subscribed images.

1
Overrideboolean

Indicates whether the original image is overwritten.

true
Accelerateboolean

Indicates whether an acceleration link is enabled for image subscription. The subscription acceleration feature is in public preview. The feature is optimized based on scheduling policies and network links to accelerate image subscription.

true
CreateTimelong

The time when the subscription rule was created.

1570759546000
ModifiedTimelong

The time when the subscription rule was modified.

1638259914000
Platformarray

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

Platformstring

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
Enumeration Value:
  • linux/arm: linux/arm.
  • windows/x86: windows/x86.
  • */*: */*.
  • linux/arm64: linux/arm64.
  • windows/x86-64: windows/x86-64.
  • linux/amd64: linux/amd64.
linux/amd64

Examples

Sample success responses

JSONformat

{
  "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"
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2025-11-03API Description Update. The response structure of the API has changedView Change Details