ListTagResources - Query resource tags | ACR API - Container Registry

Queries the list of tags that are bound to resources. Currently, Instance resources are supported.

Operation description

At least one of ResourceId.N or (Tag.N.Key, Tag.N.Value) must be specified in the request to determine the objects to query.
Tag.N is a tag of the resource, which consists of a key-value pair. If you specify only Tag.N.Key, all tag values associated with the specified tag key are returned. If you specify only Tag.N.Value, an error is returned.
ResourceId.N must match all specified key-value pairs. If you specify multiple key-value pairs, the query results include only resources that contain all the specified key-value pairs.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceType	string	Yes	The resource type. Currently, Instance resources are supported. Valid values: Instance : Container Registry instance.	Instance
ResourceId	array	No	The resource ID. You can specify up to 20 resources.
	string	No	The resource ID.	cri-5w1ztcu2kruj****
RegionId	string	Yes	The region ID of the resource.	cn-hangzhou
Tag	array<object>	No	The list of tags.
	object	No	The list of tags.
Key	string	No	The tag key of the resource. You can specify up to 20 tag keys. If you specify this parameter, you cannot set it to an empty string. A tag key can be up to 128 characters in length and cannot start with `aliyun` or `acs:`, or contain `http://` or `https://`.	test-key
Value	string	No	The tag value of the resource. You can specify up to 20 tag values. If you specify this parameter, you can set it to an empty string. A tag value can be up to 128 characters in length and cannot start with `aliyun` or `acs:`, or contain `http://` or `https://`.	test-val
NextToken	string	No	The token for the next query. You do not need to specify this parameter for the first query or if no more results exist. If a next query exists, set this parameter to the NextToken value returned by the previous API call.	AAAAAfj+3fkqd8igM6VLaQjlaYc=

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	7FF809ED-B42F-5AC3-9A17-CFE14BE32A8E
TagResources	object
TagResource	array<object>	The list of tag resources.
	object
TagKey	string	The tag key.	test-key
TagValue	string	The tag value.	test-val
ResourceId	string	The resource ID.	cri-w19e7qr2wibl****
ResourceType	string	The resource type.	Instance
NextToken	string	The token for the next query. You do not need to specify this parameter for the first query or if no more results exist. If a next query exists, set this parameter to the NextToken value returned by the previous API call.	AAAAAfj+3fkqd8igM6VLaQjlaYc=

Examples

Success response

JSON format

{
  "RequestId": "7FF809ED-B42F-5AC3-9A17-CFE14BE32A8E",
  "TagResources": {
    "TagResource": [
      {
        "TagKey": "test-key\n",
        "TagValue": "test-val",
        "ResourceId": "cri-w19e7qr2wibl****",
        "ResourceType": "Instance"
      }
    ]
  },
  "NextToken": "AAAAAfj+3fkqd8igM6VLaQjlaYc=\n"
}

Error codes

HTTP status code	Error code	Error message
400	SystemError	A system error occurred while processing your request
400	InvalidParameter.ResourceType	The ResourceType parameter is invalid.
400	MissingParameter.ResourceIdsOrTags	You must specify ResourceId.N or Tags.
400	MissingParameter.ResourceType	You must specify ResourceType.
400	MissingParameter.TagKey	You must specify Tag.N.Key.
400	NumberExceed.ResourceIds	The maximum number of ResourceIds is exceeded.
400	NumberExceed.Tags	The maximum number of Tags is exceeded.
400	Duplicate.TagKey	The Tag.N.Key contains duplicate keys.
400	InvalidParameter.NextToken	The NextToken parameter is invalid.
403	NoPermission	The operator is not permission for this operate

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.