ListArtifactSubscriptionRule API Overview - Container Registry - Alibaba Cloud - Container Registry

Lists artifact subscription rules.

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:ListArtifactSubscriptionRule

list

*Instance

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

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	cri-c0o11woew0k****
PageNo	integer	No	The current page number.	1
PageSize	integer	No	The number of entries per page. Maximum value: 100. If the specified value exceeds 100, the system returns a parameter error or uses 100 as the actual maximum number of entries per page.	30

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	07FC5654-C82A-59FA-A9D1-78B4EE443F86
Code	string	The return code.	success
PageNo	integer	The page number.	1
IsSuccess	boolean	Indicates whether the call was successful. Valid values: `true`: The call was successful. `false`: The call failed.	true
PageSize	integer	The number of entries per page.	30
TotalCount	integer	The total number of entries.	13
Rules	array<object>	The list of rules.
	object	The list of rules.
InstanceId	string	The instance ID.	cri-brlg4cbj2yl****
RuleId	string	The rule ID.	crasr-mdbpung4i1rm****
SourceProvider	string	The artifact source. 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 namespace name.	test-ns
RepoName	string	The repository name.	test-repo
TagRegexp	string	The image version subscribed from the source repository. Regular expressions are supported.	release.*
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.	1638187989000
ModifiedTime	integer	The modification time. The value is a UNIX timestamp in milliseconds.	1678341923385
Platform	array	The operating system/architecture. If the source repository contains multi-architecture images, only the specified operating system/architecture is subscribed to the target repository of the Enterprise instance.
	string	The operating system/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	/
SourceDomain	string

Examples

Success response

JSON format

{
  "RequestId": "07FC5654-C82A-59FA-A9D1-78B4EE443F86",
  "Code": "success",
  "PageNo": 1,
  "IsSuccess": true,
  "PageSize": 30,
  "TotalCount": 13,
  "Rules": [
    {
      "InstanceId": "cri-brlg4cbj2yl****",
      "RuleId": "crasr-mdbpung4i1rm****\n",
      "SourceProvider": "DOCKER_HUB",
      "SourceNamespaceName": "library",
      "SourceRepoName": "nginx",
      "NamespaceName": "test-ns",
      "RepoName": "test-repo",
      "TagRegexp": "release.*",
      "TagCount": 1,
      "Override": true,
      "Accelerate": true,
      "CreateTime": 1638187989000,
      "ModifiedTime": 1678341923385,
      "Platform": [
        "*/*"
      ],
      "SourceDomain": ""
    }
  ]
}

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.