All Products
Document Center

ApsaraDB for MongoDB:ListTagResources

Last Updated:Jan 17, 2023

Queries the relationship between ApsaraDB for MongoDB instances and tags.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All resources is used in the Resource type column of the operation.
  • Condition keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operate access level Resource type conditional keyword Association operation
dds:ListTagResources LIST
  • MongoDB

Request parameters

Parameter Type Required Description Example
RegionId string Yes

The region ID of the instance. You can call the DescribeDBInstanceAttribute operation to query the region ID of the instance.

ResourceType string Yes

The resource type. Set the value to INSTANCE.

NextToken string No

The token used to start the next query to retrieve more results.

Note This parameter is not required in the first query. If not all results are returned in one query, you can pass in the NextToken value returned in the previous query to perform the query again.
ResourceId array No

The resource IDs. You must specify this parameter or the Tag parameter.

string No

The ID of the instance.

Tag array No

The tags that are attached to the resources.

object No
Key string No

The key of tag.

Value string No

The value of tag.


Response parameters

Parameter Type Description Example
NextToken string

The token used to start the next query.

Note If not all results are returned in the first query, this parameter is returned. You can pass in the returned value of this parameter in the next query.
RequestId string

The ID of the request.

TagResources array

Details about the tags of the instance.

ResourceType string

The resource type. The return value is fixed to ALIYUN: KVSTORE: INSTANCE, indicating an ApsaraDB for MongoDB instance.

TagValue string

The value of the tag.

ResourceId string

The ID of the resource. It is the ID of the ApsaraDB for MongoDB instance.

TagKey string

The key of the tag.



Normal return example


  "NextToken": "212db86****",
  "RequestId": "96017AF2-9AB1-4BC9-88D2-7966B3CD****",
  "TagResources": {
    "TagResource": [
        "ResourceType": "ALIYUN::DDS::INSTANCE",
        "TagValue": "dev",
        "ResourceId": "dds-bp17e7a04960****",
        "TagKey": "Environment"

Error codes

Http code Error code Error message
400 InvalidTagKey.Malformed The specified parameter 'Tag.n.Key' or 'TagKey.n' is not valid.
400 InvalidTagValue.Malformed The specified parameter 'Tag.n.Value' is not valid.
400 InvalidParameter.ResourceId The specified parameter 'ResourceId.n' is not valid.
400 MissParameter.TagOrResourceId The parameter 'Tag.n'' or 'ResourceId.n' is needed.
400 InvalidParameter.Scope The specified parameter 'Scope' is not valid.
400 NumberExceed.ResourceIds The ResourceIds parameter's number is exceed.
400 NumberExceed.Tags The Tags parameter's number is exceed.
400 Duplicate.TagKey The specified parameter 'Tag.n.Key' is duplicated.
400 InvalidParameter.ResourceType The specified parameter 'ResourceType' is not valid.
404 InvalidDbInstanceId.NotFound Specified instance does not exist.

For a list of error codes, visit the API error center.