All Products
Search
Document Center

Container Registry:CreateArtifactSubscriptionRule

Last Updated:Dec 16, 2025

Creates 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:CreateArtifactSubscriptionRulecreate
*Instance
acs:cr:{#regionId}:{#accountId}:instance/{#InstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The instance ID.

cri-c0o11woew0k****
SourceProviderstringYes

The source of the artifact.

Valid values:

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

The source namespace.

library
SourceRepoNamestringNo

The source repository.

nginx
NamespaceNamestringYes

The name of the Container Registry namespace.

test-ns
RepoNamestringNo

The name of the Container Registry repository.

test-repo
TagRegexpstringNo

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

release-v.*
TagCountlongNo

The number of subscribed images.

1
OverridebooleanNo

Indicates whether the original image is overwritten.

true
AcceleratebooleanNo

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
PlatformarrayNo

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

stringNo

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

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The return value.

success
IsSuccessboolean

Indicate whether the API request is successful. Valid values:

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

The request ID.

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

The ID of the artifact subscription rule.

crasr-lxdfele7dg4****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
403NoPrivilegeAccess is denied for the user.The user is not authorized.
500SystemErrorA system error occurred.An unknown error occurred.

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

Change history

Change timeSummary of changesOperation
No change history