ListTagResources - Query tags bound to NAS resources - File Storage NAS

Queries tags bound to NAS resources.

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

nas:ListTagResources

get

*FileSystem

acs:nas:{#regionId}:{#accountId}:filesystem/{#filesystemId}

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceType	string	Yes	The type of the resource. Valid values: filesystem accesspoint	filesystem
NextToken	string	No	The pagination token for retrieving the next page of results.	N/A
ResourceId	array	No	The resource ID. Valid values of N: 1 to 50.	03e08484f0
	string	No	The resource ID. General-purpose NAS file system: 31a8e4**. Extreme NAS file system: must start with extreme-, for example, extreme-0015. CPFS file system: must start with cpfs-, for example, cpfs-125487. Access point: {file system ID}/{access point ID}, for example, 31a8e4/ap-896m22**.	03e08484f0
Tag	array<object>	No	The tags to query. You can specify up to 20 tags. Each tag key must be unique.
	object	No	The tag.
Key	string	No	The key of a tag. Constraints: Cannot be null or empty. Maximum length: 128 characters. Cannot start with `aliyun` or `acs:`. Cannot contain `http://` or `https://`.	nastest
Value	string	No	The value of a tag. Constraints: Maximum length: 128 characters. Cannot contain `http://` or `https://`.	filetest

Response elements

Element	Type	Description	Example
	object
NextToken	string	A pagination token for the next request. If null, no more results are available.	N/A
RequestId	string	The request ID.	2D69A58F-345C-4FDE-88E4-BF518948****
TagResources	object
TagResource	array<object>	The list of resources.
	object
ResourceType	string	The resource type.	filesystem
TagValue	string	The tag value.	test
ResourceId	string	The resource ID.	i-2zebd226fxed6h4iadhe
TagKey	string	The tag key.	test1

Examples

Success response

JSON format

{
  "NextToken": " 无",
  "RequestId": "2D69A58F-345C-4FDE-88E4-BF518948****",
  "TagResources": {
    "TagResource": [
      {
        "ResourceType": "filesystem",
        "TagValue": "test",
        "ResourceId": "i-2zebd226fxed6h4iadhe",
        "TagKey": "test1"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter.ResourceIdOrTag	Either ResourceId or Tag must be specified.	Either ResourceId or Tag must be specified.
400	InvalidNextToken	The NextToken is invalid.	The NextToken is invalid.
400	NumberExceed.ResourceIds	The maximum number of ResourceIds is exceeded. The maximum is 50.	The maximum number of resource ID is exceeded. The maximum is 50.
400	MissingParameter.ResourceIds	You must specify ResourceIds.	You must specify ResourceId.
400	Duplicate.ResourceId	The request contains duplicated ResourceId.	ResourceId cannot be duplicated.
400	NumberExceed.Tags	The maximum number of Tags is exceeded. The maximum is 20.	The maximum number of Tags is exceeded. The maximum is 20.
400	Duplicate.TagKey	The Tag.N.Key contains a duplicated key.	The specified TagKey is duplicated.
400	InvalidResourceId.NotFound	The ResourceId does not exist.	The specified ResourceId does not exist.
400	InvalidParameter.TagKey	The specified Tag.n.Key is invalid.	The specified TagKey is invalid.
400	InvalidParameter.TagValue	The specified Tag.n.Value is invalid.	The specified TagValue is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.