Use DescribeUserTagKeys to query tag keys for disks and snapshots - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Centralized Role: Query User Disk Snapshot tagKeys

Operation description

Interface Description

Query the tag key-value pairs of user's cloud disk and snapshot. The search scope can be narrowed down by using filterTagKey.

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

ebs:DescribeUserTagKeys

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
NextToken	string	No	The query token returned by this call (Token).	f07b150eadfa1d7a
MaxResults	integer	No	Number of items per page in paginated queries. The maximum value is 100. Default value: If no value is set or the set value is less than 10, the default is 10. If the set value is greater than 100, the default is 100.	10
TagFilterKey	string	No	The tagKey for filtering the query.	tagKey
RegionId	string	No	The ID of the region to which the resource belongs. You can call DescribeRegions to view the latest list of Alibaba Cloud regions.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	DescribeLensUserTagKeyResponse
TagKeys	array	List of matching tag keys.
	string	List of matching tag keys.	{'TagKey': []}
NextToken	string	The token for the next query. An empty NextToken indicates there are no more results.	f07b150eadfa1d7a
RequestId	string	Request ID.	C123F94F-4E38-19AE-942A-A8D6F44F****
MaxResults	integer	Number of items per page in paginated queries. The maximum value is 100. Default value: If no value is set or the set value is less than 10, the default is 10. If the set value is greater than 100, the default is 100.	10

Examples

Success response

JSON format

{
  "TagKeys": [
    "{'TagKey': []}"
  ],
  "NextToken": "f07b150eadfa1d7a",
  "RequestId": "C123F94F-4E38-19AE-942A-A8D6F44F****",
  "MaxResults": 10
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParameter	The parameter %s is invalid.
400	InvalidParameter.Conflict	The specified parameter %s and %s are not blank at the same time.
400	InvalidParameter.Format	Specified parameter format is not valid.
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.
403	Forbidden	User is not authorized to operate.
403	Forbidden.Action	User is not authorized to operate this action.
403	InvalidAccountStatus.NotEnoughBalance	Your account does not have enough balance.
403	LastTokenProcessing	The last token request is processing.
403	NoPermission.SLR	The RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS.
403	OperationDenied	The operation is not allowed.
404	InvalidApi.NotFound	Specified api is not found, please check your url and method.
404	NoSuchResource	The specified resource does not exist.
504	RequestTimeout	The request is timeout, please try again later.
429	BLOCK.LimitedRequest	Request was denied due to user flow control.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.